Updated findings api error responses (#1486)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-06-14 07:21:00.798021",
-            "spec_repo_commit": "87ef2d8d"
+            "regenerated": "2023-06-14 09:53:27.834820",
+            "spec_repo_commit": "e0974b9b"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-06-14 07:21:00.814393",
-            "spec_repo_commit": "87ef2d8d"
+            "regenerated": "2023-06-14 09:53:27.851959",
+            "spec_repo_commit": "e0974b9b"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -477,6 +477,31 @@ components:
           schema:
             $ref: '#/components/schemas/APIErrorResponse'
       description: Conflict
+    FindingsBadRequestResponse:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/JSONAPIErrorResponse'
+      description: 'Bad Request: The server cannot process the request due to invalid
+        syntax in the request.'
+    FindingsForbiddenResponse:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/JSONAPIErrorResponse'
+      description: 'Forbidden: Access denied'
+    FindingsNotFoundResponse:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/JSONAPIErrorResponse'
+      description: 'Not Found: The requested finding cannot be found.'
+    FindingsTooManyRequestsResponse:
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/JSONAPIErrorResponse'
+      description: 'Too many requests: The rate limit set by the API has been exceeded.'
     ForbiddenResponse:
       content:
         application/json:
@@ -4520,34 +4545,6 @@ components:
       type: string
       x-enum-varnames:
       - FINDING
-    FindingsErrorItem:
-      description: API error response body
-      properties:
-        detail:
-          description: A human-readable explanation specific to this occurrence of
-            the error.
-          example: attribute "muted" is required
-          type: string
-        status:
-          description: Status code of the response.
-          example: '400'
-          type: string
-        title:
-          description: Short human-readable summary of the error.
-          example: Bad Request
-          type: string
-      type: object
-    FindingsErrorResponse:
-      description: API error response.
-      properties:
-        errors:
-          description: A list of errors.
-          items:
-            $ref: '#/components/schemas/FindingsErrorItem'
-          type: array
-      required:
-      - errors
-      type: object
     FormulaLimit:
       description: Message for specifying limits to the number of values returned
         by a query.
@@ -6839,6 +6836,34 @@ components:
             type: string
           type: array
       type: object
+    JSONAPIErrorItem:
+      description: API error response body
+      properties:
+        detail:
+          description: A human-readable explanation specific to this occurrence of
+            the error.
+          example: Missing required attribute in body
+          type: string
+        status:
+          description: Status code of the response.
+          example: '400'
+          type: string
+        title:
+          description: Short human-readable summary of the error.
+          example: Bad Request
+          type: string
+      type: object
+    JSONAPIErrorResponse:
+      description: API error response.
+      properties:
+        errors:
+          description: A list of errors.
+          items:
+            $ref: '#/components/schemas/JSONAPIErrorItem'
+          type: array
+      required:
+      - errors
+      type: object
     JiraIntegrationMetadata:
       description: Incident integration metadata for the Jira integration.
       properties:
@@ -20715,13 +20740,16 @@ paths:
         can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*`
         to filter for any non-AWS resources.\n\nThe operator must come after the equal
         sign. For example, to filter with the `>=` operator, add the operator after
-        the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\n### Response\n\nThe
-        response includes an array of finding objects, pagination metadata, and a
-        count of items that match the query.\n\nEach finding object contains the following:\n\n-
-        The finding ID that can be used in a `GetFinding` request to retrieve the
-        full finding details.\n- Core attributes, including status, evaluation, high-level
-        resource details, muted state, and rule details.\n- `evaluation_changed_at`
-        and `resource_discovery_date` time stamps.\n- An array of associated tags.\n"
+        the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery
+        parameters must be only among the documented ones and with values of correct
+        types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`)
+        are not allowed.\n\n### Response\n\nThe response includes an array of finding
+        objects, pagination metadata, and a count of items that match the query.\n\nEach
+        finding object contains the following:\n\n- The finding ID that can be used
+        in a `GetFinding` request to retrieve the full finding details.\n- Core attributes,
+        including status, evaluation, high-level resource details, muted state, and
+        rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time
+        stamps.\n- An array of associated tags.\n"
       operationId: ListFindings
       parameters:
       - description: Limit the number of findings returned. Must be <= 1000.
@@ -20821,17 +20849,13 @@ paths:
                 $ref: '#/components/schemas/ListFindingsResponse'
           description: OK
         '400':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/APIErrorResponse'
-          description: Bad Request
+          $ref: '#/components/responses/FindingsBadRequestResponse'
         '403':
-          $ref: '#/components/responses/ForbiddenResponse'
+          $ref: '#/components/responses/FindingsForbiddenResponse'
         '404':
-          $ref: '#/components/responses/NotFoundResponse'
+          $ref: '#/components/responses/FindingsNotFoundResponse'
         '429':
-          $ref: '#/components/responses/TooManyRequestsResponse'
+          $ref: '#/components/responses/FindingsTooManyRequestsResponse'
       security:
       - apiKeyAuth: []
         appKeyAuth: []
@@ -20876,17 +20900,13 @@ paths:
                 $ref: '#/components/schemas/GetFindingResponse'
           description: OK
         '400':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/APIErrorResponse'
-          description: Bad Request
+          $ref: '#/components/responses/FindingsBadRequestResponse'
         '403':
-          $ref: '#/components/responses/ForbiddenResponse'
+          $ref: '#/components/responses/FindingsForbiddenResponse'
         '404':
-          $ref: '#/components/responses/NotFoundResponse'
+          $ref: '#/components/responses/FindingsNotFoundResponse'
         '429':
-          $ref: '#/components/responses/TooManyRequestsResponse'
+          $ref: '#/components/responses/FindingsTooManyRequestsResponse'
       security:
       - apiKeyAuth: []
         appKeyAuth: []
@@ -20934,39 +20954,27 @@ paths:
                 $ref: '#/components/schemas/MuteFindingResponse'
           description: OK
         '400':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/FindingsErrorResponse'
-          description: 'Bad Request: The server cannot process the request due to
-            invalid syntax in the request.'
+          $ref: '#/components/responses/FindingsBadRequestResponse'
+        '403':
+          $ref: '#/components/responses/FindingsForbiddenResponse'
         '404':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/FindingsErrorResponse'
-          description: 'Not Found: The requested finding cannot be found.'
+          $ref: '#/components/responses/FindingsNotFoundResponse'
         '409':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FindingsErrorResponse'
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
           description: 'Resource Conflict: The finding has already been muted or unmuted
             within the last 60 seconds.'
         '422':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/FindingsErrorResponse'
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
           description: 'Invalid Request: The server understands the request syntax
             but cannot process it due to invalid data.'
         '429':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/FindingsErrorResponse'
-          description: 'Too many requests: The rate limit set by the API has been
-            exceeded.'
+          $ref: '#/components/responses/FindingsTooManyRequestsResponse'
       security:
       - apiKeyAuth: []
         appKeyAuth: []

docs/datadog_api_client.v2.model.rst

@@ -1737,20 +1737,6 @@ finding\_type
    :members:
    :show-inheritance:
 
-findings\_error\_item
----------------------
-
-.. automodule:: datadog_api_client.v2.model.findings_error_item
-   :members:
-   :show-inheritance:
-
-findings\_error\_response
--------------------------
-
-.. automodule:: datadog_api_client.v2.model.findings_error_response
-   :members:
-   :show-inheritance:
-
 formula\_limit
 --------------
 
@@ -2871,6 +2857,20 @@ jira\_integration\_metadata\_issues\_item
    :members:
    :show-inheritance:
 
+jsonapi\_error\_item
+--------------------
+
+.. automodule:: datadog_api_client.v2.model.jsonapi_error_item
+   :members:
+   :show-inheritance:
+
+jsonapi\_error\_response
+------------------------
+
+.. automodule:: datadog_api_client.v2.model.jsonapi_error_response
+   :members:
+   :show-inheritance:
+
 list\_application\_keys\_response
 ---------------------------------
 

src/datadog_api_client/v2/api/security_monitoring_api.py

@@ -888,6 +888,8 @@ def list_findings(
 
         The operator must come after the equal sign. For example, to filter with the ``>=`` operator, add the operator after the equal sign: ``filter[evaluation_changed_at]=>=1678809373257``.
 
+        Query parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. ``filter[status]=low&filter[status]=info`` ) are not allowed.
+
         **Response**
 
         The response includes an array of finding objects, pagination metadata, and a count of items that match the query.

src/datadog_api_client/v2/model/findings_error_item.py renamed to src/datadog_api_client/v2/model/jsonapi_error_item.py

@@ -13,7 +13,7 @@
 )
 
 
-class FindingsErrorItem(ModelNormal):
+class JSONAPIErrorItem(ModelNormal):
     @cached_property
     def openapi_types(_):
         return {

src/datadog_api_client/v2/model/findings_error_response.py renamed to src/datadog_api_client/v2/model/jsonapi_error_response.py

@@ -12,28 +12,28 @@
 
 
 if TYPE_CHECKING:
-    from datadog_api_client.v2.model.findings_error_item import FindingsErrorItem
+    from datadog_api_client.v2.model.jsonapi_error_item import JSONAPIErrorItem
 
 
-class FindingsErrorResponse(ModelNormal):
+class JSONAPIErrorResponse(ModelNormal):
     @cached_property
     def openapi_types(_):
-        from datadog_api_client.v2.model.findings_error_item import FindingsErrorItem
+        from datadog_api_client.v2.model.jsonapi_error_item import JSONAPIErrorItem
 
         return {
-            "errors": ([FindingsErrorItem],),
+            "errors": ([JSONAPIErrorItem],),
         }
 
     attribute_map = {
         "errors": "errors",
     }
 
-    def __init__(self_, errors: List[FindingsErrorItem], **kwargs):
+    def __init__(self_, errors: List[JSONAPIErrorItem], **kwargs):
         """
         API error response.
 
         :param errors: A list of errors.
-        :type errors: [FindingsErrorItem]
+        :type errors: [JSONAPIErrorItem]
         """
         super().__init__(kwargs)
 

src/datadog_api_client/v2/models/__init__.py

@@ -292,8 +292,6 @@
 from datadog_api_client.v2.model.finding_rule import FindingRule
 from datadog_api_client.v2.model.finding_status import FindingStatus
 from datadog_api_client.v2.model.finding_type import FindingType
-from datadog_api_client.v2.model.findings_error_item import FindingsErrorItem
-from datadog_api_client.v2.model.findings_error_response import FindingsErrorResponse
 from datadog_api_client.v2.model.formula_limit import FormulaLimit
 from datadog_api_client.v2.model.full_api_key import FullAPIKey
 from datadog_api_client.v2.model.full_api_key_attributes import FullAPIKeyAttributes
@@ -484,6 +482,8 @@
 from datadog_api_client.v2.model.incident_update_request import IncidentUpdateRequest
 from datadog_api_client.v2.model.incidents_response import IncidentsResponse
 from datadog_api_client.v2.model.intake_payload_accepted import IntakePayloadAccepted
+from datadog_api_client.v2.model.jsonapi_error_item import JSONAPIErrorItem
+from datadog_api_client.v2.model.jsonapi_error_response import JSONAPIErrorResponse
 from datadog_api_client.v2.model.jira_integration_metadata import JiraIntegrationMetadata
 from datadog_api_client.v2.model.jira_integration_metadata_issues_item import JiraIntegrationMetadataIssuesItem
 from datadog_api_client.v2.model.list_application_keys_response import ListApplicationKeysResponse

tests/v2/features/security_monitoring.feature

@@ -199,20 +199,20 @@ Feature: Security Monitoring
     And the response "id" has the same value as "cloud_configuration_rule.id"
 
   @generated @skip @team:DataDog/cloud-security-posture-management
-  Scenario: Get a finding returns "Bad Request" response
+  Scenario: Get a finding returns "Bad Request: The server cannot process the request due to invalid syntax in the request." response
     Given operation "GetFinding" enabled
     And new "GetFinding" request
     And request contains "finding_id" parameter from "REPLACE.ME"
     When the request is sent
-    Then the response status is 400 Bad Request
+    Then the response status is 400 Bad Request: The server cannot process the request due to invalid syntax in the request.
 
   @generated @skip @team:DataDog/cloud-security-posture-management
-  Scenario: Get a finding returns "Not Found" response
+  Scenario: Get a finding returns "Not Found: The requested finding cannot be found." response
     Given operation "GetFinding" enabled
     And new "GetFinding" request
     And request contains "finding_id" parameter from "REPLACE.ME"
     When the request is sent
-    Then the response status is 404 Not Found
+    Then the response status is 404 Not Found: The requested finding cannot be found.
 
   @replay-only @team:DataDog/cloud-security-posture-management
   Scenario: Get a finding returns "OK" response
@@ -325,18 +325,18 @@ Feature: Security Monitoring
     And the response "data" has item with field "attributes.is_builtin" with value true
 
   @generated @skip @team:DataDog/cloud-security-posture-management
-  Scenario: List findings returns "Bad Request" response
+  Scenario: List findings returns "Bad Request: The server cannot process the request due to invalid syntax in the request." response
     Given operation "ListFindings" enabled
     And new "ListFindings" request
     When the request is sent
-    Then the response status is 400 Bad Request
+    Then the response status is 400 Bad Request: The server cannot process the request due to invalid syntax in the request.
 
   @generated @skip @team:DataDog/cloud-security-posture-management
-  Scenario: List findings returns "Not Found" response
+  Scenario: List findings returns "Not Found: The requested finding cannot be found." response
     Given operation "ListFindings" enabled
     And new "ListFindings" request
     When the request is sent
-    Then the response status is 404 Not Found
+    Then the response status is 404 Not Found: The requested finding cannot be found.
 
   @replay-only @team:DataDog/cloud-security-posture-management
   Scenario: List findings returns "OK" response