Mirrors/plane
1
0
Fork 0
mirror of https://github.com/makeplane/plane.git synced 2026-09-01 19:48:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

[WEB-8382][WEB-8383] docs: document 403 responses in the OpenAPI contract

Browse Source 
The author/admin guard on comment update+delete and the project-membership
guard on attachment list all return 403, but their explicit `responses` maps
omitted it, so the generated schema advertised only 400/404/409.

Adds `403: FORBIDDEN_RESPONSE` (already imported) to update_work_item_comment,
delete_work_item_comment and list_work_item_attachments.

Addresses CodeRabbit review on #9475.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Manish Gupta
2026-07-31 16:59:25 +05:30
parent 02f2d44abe
commit b9a01fdaef
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
apps/api/plane/api/views/issue.py
View File

@@ -1591,6 +1591,7 @@ class IssueCommentDetailAPIEndpoint(BaseAPIView):
examples=[ISSUE_COMMENT_EXAMPLE],
),
400: INVALID_REQUEST_RESPONSE,
403: FORBIDDEN_RESPONSE,
404: COMMENT_NOT_FOUND_RESPONSE,
409: EXTERNAL_ID_EXISTS_RESPONSE,
},
@@ -1672,6 +1673,7 @@ class IssueCommentDetailAPIEndpoint(BaseAPIView):
],
responses={
204: OpenApiResponse(description="Work item comment deleted successfully"),
403: FORBIDDEN_RESPONSE,
404: COMMENT_NOT_FOUND_RESPONSE,
},
)
@@ -2014,6 +2016,7 @@ class IssueAttachmentListCreateAPIEndpoint(BaseAPIView):
examples=[ISSUE_ATTACHMENT_EXAMPLE],
),
400: INVALID_REQUEST_RESPONSE,
403: FORBIDDEN_RESPONSE,
404: ATTACHMENT_NOT_FOUND_RESPONSE,
},
)