Skip to content

Commit 841f4b7

Browse files
authored
docs(api): Clarify how to use id param in bulk delete issue endpoint (#56422)
Closes #56315 The existing docs: 1. Do not describe the query param format for deleting multiple IDs 2. Do not describe what happens when you do not provide an `id` param After: <img width="493" alt="Screenshot 2023-09-19 at 10 24 32 AM" src="https://github.com/getsentry/sentry/assets/67301797/95fcde13-93f0-47f7-914e-3848de6239e3">
1 parent f789663 commit 841f4b7

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

api-docs/paths/events/project-issues.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@
324324
{
325325
"name": "id",
326326
"in": "query",
327-
"description": "A list of IDs of the issues to be removed. This parameter shall be repeated for each issue.",
327+
"description": "A list of IDs of the issues to be removed. This parameter shall be repeated for each issue, e.g. `?id=1&id=2&id=3`. If this parameter is not provided, it will attempt to remove the first 1000 issues.",
328328
"schema": {
329329
"type": "integer"
330330
}

src/sentry/api/endpoints/organization_group_index.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,9 @@ def delete(self, request: Request, organization) -> Response:
479479
any data mutation.
480480
481481
:qparam int id: a list of IDs of the issues to be removed. This
482-
parameter shall be repeated for each issue.
482+
parameter shall be repeated for each issue, e.g.
483+
`?id=1&id=2&id=3`. If this parameter is not provided,
484+
it will attempt to remove the first 1000 issues.
483485
:pparam string organization_slug: the slug of the organization the
484486
issues belong to.
485487
:auth: required

0 commit comments

Comments
 (0)