Document required app key scopes (#2084)

Co-authored-by: ci.datadog-api-spec <[email protected]>
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-08-01 17:35:37.919014",
-            "spec_repo_commit": "0ac23b7a"
+            "regenerated": "2024-08-01 21:20:11.603374",
+            "spec_repo_commit": "55d5616e"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-01 17:35:37.936141",
-            "spec_repo_commit": "0ac23b7a"
+            "regenerated": "2024-08-01 21:20:11.620598",
+            "spec_repo_commit": "55d5616e"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -38048,7 +38048,8 @@ paths:
       - Teams
   /api/v2/workflows/{workflow_id}/instances:
     get:
-      description: List all instances of a given workflow.
+      description: List all instances of a given workflow. This API requires an application
+        key scoped with the workflows_read permission.
       operationId: ListWorkflowInstances
       parameters:
       - $ref: '#/components/parameters/WorkflowId'
@@ -38071,7 +38072,8 @@ paths:
       tags:
       - Workflow Automation
     post:
-      description: Execute the given workflow
+      description: Execute the given workflow. This API requires an application key
+        scoped with the workflows_run permission.
       operationId: CreateWorkflowInstance
       parameters:
       - $ref: '#/components/parameters/WorkflowId'
@@ -38100,7 +38102,8 @@ paths:
       x-codegen-request-body-name: body
   /api/v2/workflows/{workflow_id}/instances/{instance_id}:
     get:
-      description: Get a specific execution of a given workflow.
+      description: Get a specific execution of a given workflow. This API requires
+        an application key scoped with the workflows_read permission.
       operationId: GetWorkflowInstance
       parameters:
       - $ref: '#/components/parameters/WorkflowId'
@@ -38125,7 +38128,8 @@ paths:
       - Workflow Automation
   /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
     put:
-      description: Cancels a specific execution of a given workflow.
+      description: Cancels a specific execution of a given workflow. This API requires
+        an application key scoped with the workflows_run permission.
       operationId: CancelWorkflowInstance
       parameters:
       - $ref: '#/components/parameters/WorkflowId'

src/datadog_api_client/v2/api/workflow_automation_api.py

@@ -152,7 +152,7 @@ def cancel_workflow_instance(
     ) -> WorklflowCancelInstanceResponse:
         """Cancel a workflow instance.
 
-        Cancels a specific execution of a given workflow.
+        Cancels a specific execution of a given workflow. This API requires an application key scoped with the workflows_run permission.
 
         :param workflow_id: The ID of the workflow.
         :type workflow_id: str
@@ -174,7 +174,7 @@ def create_workflow_instance(
     ) -> WorkflowInstanceCreateResponse:
         """Execute a workflow.
 
-        Execute the given workflow
+        Execute the given workflow. This API requires an application key scoped with the workflows_run permission.
 
         :param workflow_id: The ID of the workflow.
         :type workflow_id: str
@@ -195,7 +195,7 @@ def get_workflow_instance(
     ) -> WorklflowGetInstanceResponse:
         """Get a workflow instance.
 
-        Get a specific execution of a given workflow.
+        Get a specific execution of a given workflow. This API requires an application key scoped with the workflows_read permission.
 
         :param workflow_id: The ID of the workflow.
         :type workflow_id: str
@@ -219,7 +219,7 @@ def list_workflow_instances(
     ) -> WorkflowListInstancesResponse:
         """List workflow instances.
 
-        List all instances of a given workflow.
+        List all instances of a given workflow. This API requires an application key scoped with the workflows_read permission.
 
         :param workflow_id: The ID of the workflow.
         :type workflow_id: str