From 5fff3b920d24bca67dcabda7201b586a9d1cd51f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Pe=C3=B1a?= Date: Mon, 6 Apr 2026 14:30:38 +0200 Subject: [PATCH] fix(api): exclude spurious retrieve from Jira docs and add known limitations (#10580) --- api/src/backend/api/v1/views.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/api/src/backend/api/v1/views.py b/api/src/backend/api/v1/views.py index 4f015f266e..cf4f752052 100644 --- a/api/src/backend/api/v1/views.py +++ b/api/src/backend/api/v1/views.py @@ -6153,7 +6153,15 @@ class IntegrationViewSet(BaseRLSViewSet): tags=["Integration"], summary="Send findings to a Jira integration", description="Send a set of filtered findings to the given integration. At least one finding filter must be " - "provided.", + "provided.\n\n" + "## Known Limitations\n\n" + "### Issue Types with Required Custom Fields\n\n" + "Certain Jira issue types (such as Epic) may require mandatory custom fields that Prowler does not " + "currently populate when creating work items. If a selected issue type enforces required fields beyond " + 'the standard set (e.g., "Team", "Epic Name"), the work item creation will fail.\n\n' + "To avoid this, select an issue type that does not require additional custom fields - **Task**, **Bug**, " + "or **Story** typically work without restrictions. If unsure which issue types are available for a project, " + 'Prowler automatically fetches and displays them in the "Issue Type" selector when sending a finding.', responses={202: OpenApiResponse(response=TaskSerializer)}, filters=True, ) @@ -6175,6 +6183,10 @@ class IntegrationJiraViewSet(BaseRLSViewSet): def list(self, request, *args, **kwargs): raise MethodNotAllowed(method="GET") + @extend_schema(exclude=True) + def retrieve(self, request, *args, **kwargs): + raise MethodNotAllowed(method="GET") + def get_serializer_class(self): if self.action == "issue_types": return IntegrationJiraIssueTypesSerializer