ACCESS-2490: Updating documentation with required scope (#1973)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-05-15 14:46:59.394168",
-            "spec_repo_commit": "4e2ffe7b"
+            "regenerated": "2024-05-17 20:25:23.098750",
+            "spec_repo_commit": "77064b00"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-05-15 14:46:59.412619",
-            "spec_repo_commit": "4e2ffe7b"
+            "regenerated": "2024-05-17 20:25:23.116461",
+            "spec_repo_commit": "77064b00"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -34134,6 +34134,11 @@ paths:
           $ref: '#/components/responses/SpansUnprocessableEntityResponse'
         '429':
           $ref: '#/components/responses/SpansTooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_read
       summary: Get a list of spans
       tags:
       - Spans
@@ -34177,6 +34182,11 @@ paths:
           $ref: '#/components/responses/SpansUnprocessableEntityResponse'
         '429':
           $ref: '#/components/responses/SpansTooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_read
       summary: Search spans
       tags:
       - Spans

src/datadog_api_client/v2/api/spans_api.py

@@ -55,7 +55,7 @@ def __init__(self, api_client=None):
         self._list_spans_endpoint = _Endpoint(
             settings={
                 "response_type": (SpansListResponse,),
-                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
                 "endpoint_path": "/api/v2/spans/events/search",
                 "operation_id": "list_spans",
                 "http_method": "POST",
@@ -75,7 +75,7 @@ def __init__(self, api_client=None):
         self._list_spans_get_endpoint = _Endpoint(
             settings={
                 "response_type": (SpansListResponse,),
-                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
                 "endpoint_path": "/api/v2/spans/events",
                 "operation_id": "list_spans_get",
                 "http_method": "GET",

tests/v2/cassettes/test_scenarios/test_create_a_cloud_workload_security_agent_rule_returns_bad_request_response.frozen

@@ -1 +1 @@
-2024-04-23T17:57:45.044Z
+2024-03-08T14:19:03.967Z

tests/v2/cassettes/test_scenarios/test_create_a_cloud_workload_security_agent_rule_returns_bad_request_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"data":{"attributes":{"description":"Test Agent rule","enabled":true,"expression":"open.file.path
-      = sh","name":"testcreateacloudworkloadsecurityagentrulereturnsbadrequestresponse1713895065"},"type":"agent_rule"}}'
+      = sh","name":"testcreateacloudworkloadsecurityagentrulereturnsbadrequestresponse1709907543"},"type":"agent_rule"}}'
     headers:
       accept:
       - application/json
@@ -12,7 +12,7 @@ interactions:
   response:
     body:
       string: '{"errors":["input_validation_error(Field ''expression'' is invalid:
-        rule `testcreateacloudworkloadsecurityagentrulereturnsbadrequestresponse1713895065`
+        rule `testcreateacloudworkloadsecurityagentrulereturnsbadrequestresponse1709907543`
         error: syntax error `1:18: unexpected token \"sh\" (expected \"~\")`)"]}
 
         '

tests/v2/cassettes/test_scenarios/test_create_a_cloud_workload_security_agent_rule_returns_ok_response.frozen

@@ -1 +1 @@
-2024-04-23T17:57:45.232Z
+2024-03-08T14:19:04.358Z

tests/v2/cassettes/test_scenarios/test_create_a_cloud_workload_security_agent_rule_returns_ok_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"data":{"attributes":{"description":"Test Agent rule","enabled":true,"expression":"exec.file.name
-      == \"sh\"","name":"testcreateacloudworkloadsecurityagentrulereturnsokresponse1713895065"},"type":"agent_rule"}}'
+      == \"sh\"","name":"testcreateacloudworkloadsecurityagentrulereturnsokresponse1709907544"},"type":"agent_rule"}}'
     headers:
       accept:
       - application/json
@@ -11,9 +11,11 @@ interactions:
     uri: https://api.datadoghq.com/api/v2/security_monitoring/cloud_workload_security/agent_rules
   response:
     body:
-      string: '{"data":{"id":"igj-qzb-9eq","attributes":{"version":1,"name":"testcreateacloudworkloadsecurityagentrulereturnsokresponse1713895065","description":"Test
-        Agent rule","expression":"exec.file.name == \"sh\"","category":"Process Activity","creationAuthorUuId":"3ad549bf-eba0-11e9-a77a-0705486660d0","creationDate":1713895065356,"updateAuthorUuId":"3ad549bf-eba0-11e9-a77a-0705486660d0","updateDate":1713895065356,"filters":["os
-        == \"linux\""],"actions":[],"agentConstraint":"","enabled":true,"defaultRule":false,"creator":{"name":null,"handle":"frog@datadoghq.com"},"updater":{"name":null,"handle":"frog@datadoghq.com"}},"type":"agent_rule"}}
+      string: '{"data":{"id":"svr-luf-gzy","attributes":{"version":1,"name":"testcreateacloudworkloadsecurityagentrulereturnsokresponse1709907544","description":"Test
+        Agent rule","expression":"exec.file.name == \"sh\"","category":"Process Activity","creationAuthorUuId":"cc32ddea-b5e4-11ec-93be-da7ad0900002","creationDate":1709907544744,"updateAuthorUuId":"cc32ddea-b5e4-11ec-93be-da7ad0900002","updateDate":1709907544744,"filters":["os
+        == \"linux\""],"actions":[],"agentConstraint":"","enabled":true,"defaultRule":false,"creator":{"name":"Malo
+        Le Goff","handle":"malo.legoff@datadoghq.com"},"updater":{"name":"Malo Le
+        Goff","handle":"malo.legoff@datadoghq.com"}},"type":"agent_rule"}}
 
         '
     headers:
@@ -28,7 +30,7 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/security_monitoring/cloud_workload_security/agent_rules/igj-qzb-9eq
+    uri: https://api.datadoghq.com/api/v2/security_monitoring/cloud_workload_security/agent_rules/svr-luf-gzy
   response:
     body:
       string: ''

tests/v2/cassettes/test_scenarios/test_create_a_csm_threats_agent_rule_returns_bad_request_response.frozen

@@ -1 +1 @@
-2024-04-23T17:57:44.167Z
+2024-03-28T13:57:47.808Z

tests/v2/cassettes/test_scenarios/test_create_a_csm_threats_agent_rule_returns_bad_request_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"data":{"attributes":{"description":"My Agent rule","enabled":true,"expression":"exec.file.name
-      == sh","name":"testcreateacsmthreatsagentrulereturnsbadrequestresponse1713895064"},"type":"agent_rule"}}'
+      == sh","name":"testcreateacsmthreatsagentrulereturnsbadrequestresponse1711634267"},"type":"agent_rule"}}'
     headers:
       accept:
       - application/json
@@ -12,7 +12,7 @@ interactions:
   response:
     body:
       string: '{"errors":["input_validation_error(Field ''expression'' is invalid:
-        rule `testcreateacsmthreatsagentrulereturnsbadrequestresponse1713895064` error:
+        rule `testcreateacsmthreatsagentrulereturnsbadrequestresponse1711634267` error:
         rule compilation error: field `sh` not found)"]}'
     headers:
       content-type:

tests/v2/cassettes/test_scenarios/test_create_a_csm_threats_agent_rule_returns_ok_response.frozen

@@ -1 +1 @@
-2024-04-23T17:57:44.371Z
+2024-03-28T13:57:48.169Z