discourse/spec/requests/api/schemas/json/post_delete_request.json
Blake Erickson a850568a52
DEV: Document delete post API endpoint (#15495)
Adding a spec for documenting the delete post API endpoint for our api
docs. As part of this added detailed info for the `force_destroy`
parameter for permanently deleting a post.
2022-01-07 16:09:32 -07:00

12 lines
426 B
JSON

{
"additionalProperties": false,
"properties": {
"force_destroy": {
"type": "boolean",
"example": true,
"description": "The `SiteSetting.can_permanently_delete` needs to be enabled first before this param can be used. Also this endpoint needs to be called first without `force_destroy` and then followed up with a second call 5 minutes later with `force_destroy` to permanently delete."
}
}
}