Document bulk deletion API convention - #30
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b32770c281
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| Cachet provides a RESTful JSON API that allows you to interact with the status page programmatically. The API is simple to use. | ||
|
|
||
| ## Deleting resources |
There was a problem hiding this comment.
Placing this ## heading here makes the existing ### Example response a subsection of “Deleting resources,” although that payload is a paginated incident-list response rather than a deletion response. Readers navigating this page will therefore see an unrelated response presented as the result of the documented DELETE; move this section below the example or adjust the heading hierarchy so the example remains under “JSON API.”
Useful? React with 👍 / 👎.
| ``` | ||
|
|
||
| All requested IDs must be valid and exist before Cachet deletes anything. An unqualified collection `DELETE` is rejected, | ||
| and `ids=all` is not supported. See the relevant endpoint reference for the required API-token ability. |
There was a problem hiding this comment.
The promised ability information is not present in the checked API reference: api-reference/openapi.json exposes only get and post on each of the six listed collection paths, and its individual delete operations and shared authorization-error response do not name a required token ability. Users following this sentence therefore cannot determine which ability to grant and may receive a 403; either document the abilities here or add the bulk-delete operations and their ability requirements to the referenced specification.
Useful? React with 👍 / 👎.
1 participant
Summary