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.
This commit is contained in:
parent
1ed2520589
commit
a850568a52
|
@ -291,6 +291,31 @@ describe 'posts' do
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
delete 'delete a single post' do
|
||||||
|
tags 'Posts'
|
||||||
|
operationId 'deletePost'
|
||||||
|
consumes 'application/json'
|
||||||
|
expected_request_schema = load_spec_schema('post_delete_request')
|
||||||
|
parameter name: :id, in: :path, schema: { type: :integer }
|
||||||
|
parameter name: :params, in: :body, schema: expected_request_schema
|
||||||
|
|
||||||
|
produces 'application/json'
|
||||||
|
response '200', 'success response' do
|
||||||
|
expected_response_schema = nil
|
||||||
|
schema expected_response_schema
|
||||||
|
|
||||||
|
let(:topic) { Fabricate(:topic) }
|
||||||
|
let(:post) { Fabricate(:post, topic_id: topic.id, post_number: 3) }
|
||||||
|
let(:id) { post.id }
|
||||||
|
let(:params) { { 'force_destroy' => false } }
|
||||||
|
|
||||||
|
it_behaves_like "a JSON endpoint", 200 do
|
||||||
|
let(:expected_response_schema) { expected_response_schema }
|
||||||
|
let(:expected_request_schema) { expected_request_schema }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
path '/posts/{id}/locked.json' do
|
path '/posts/{id}/locked.json' do
|
||||||
|
|
|
@ -0,0 +1,11 @@
|
||||||
|
{
|
||||||
|
"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."
|
||||||
|
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue