mirror of
https://github.com/pocketbase/pocketbase.git
synced 2026-05-24 00:36:29 -04:00
39 lines
2.9 KiB
JavaScript
39 lines
2.9 KiB
JavaScript
function e(e){let n=app.utils.getApiExampleURL(),r=e.deleteRule===null,i=[{title:204,value:`null`},{title:400,value:`
|
|
{
|
|
"status": 400,
|
|
"message": "Failed to delete record. Make sure that the record is not part of a required relation reference.",
|
|
"data": {}
|
|
}
|
|
`}];return r&&i.push({title:403,value:`
|
|
{
|
|
"status": 403,
|
|
"message": "Only superusers can access this action.",
|
|
"data": {}
|
|
}
|
|
`}),i.push({title:404,value:`
|
|
{
|
|
"status": 404,
|
|
"message": "The requested resource wasn't found.",
|
|
"data": {}
|
|
}
|
|
`}),t.div({pbEvent:`apiPreviewDelete`,className:`content`},t.p(null,`Delete a single ${e.name} record.`),app.components.codeBlockTabs({className:`sdk-examples m-t-sm`,historyKey:`pbLastSDK`,tabs:[{title:`JS SDK`,language:`js`,value:`
|
|
import PocketBase from 'pocketbase';
|
|
|
|
const pb = new PocketBase('${n}');
|
|
|
|
...
|
|
|
|
await pb.collection('${e.name}').delete('RECORD_ID');
|
|
`,footnote:t.div({className:`txt-right`},t.a({href:`https://github.com/pocketbase/js-sdk`,target:`_blank`,rel:`noopener noreferrer`,textContent:`JS SDK docs`}))},{title:`Dart SDK`,language:`dart`,value:`
|
|
import 'package:pocketbase/pocketbase.dart';
|
|
|
|
final pb = PocketBase('${n}');
|
|
|
|
...
|
|
|
|
await pb.collection('${e.name}').delete('RECORD_ID');
|
|
`,footnote:t.div({className:`txt-right`},t.a({href:`https://github.com/pocketbase/dart-sdk`,target:`_blank`,rel:`noopener noreferrer`,textContent:`Dart SDK docs`}))},{title:`curl`,language:`bash`,value:`
|
|
curl -X DELETE \\
|
|
-H 'Authorization:TOKEN' \\
|
|
'${n}/api/collections/${e.name}/records/RECORD_ID'
|
|
`}]}),t.div({className:`block m-t-base`},t.strong(null,`API details`)),t.div({className:`alert danger api-preview-alert`},t.span({className:`label method`},`DELETE`),t.span({className:`path`},`/api/collections/${e.name}/records/`,t.strong(null,`:id`)),()=>{if(r)return t.small({className:`extra`},`Requires superuser Authorization:TOKEN header`)}),t.table({className:`api-preview-table path-params`},t.thead(null,t.tr(null,t.th({className:`min-width txt-primary`},`Path params`),t.th({className:`min-width`},`Type`),t.th(null,`Description`))),t.tbody(null,t.tr(null,t.td({className:`min-width`},`id`),t.td({className:`min-width`},t.span({className:`label`},`String`)),t.td(null,`ID of the record to delete.`)))),t.div({className:`block m-t-base m-b-sm`},t.strong(null,`Example responses`)),app.components.codeBlockTabs({tabs:i}))}export{e as docsDelete}; |