Document required app key scopes (#1738)

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:36.454281",
-            "spec_repo_commit": "0ac23b7a"
+            "regenerated": "2024-08-01 21:20:18.000721",
+            "spec_repo_commit": "55d5616e"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-01 17:35:36.472862",
-            "spec_repo_commit": "0ac23b7a"
+            "regenerated": "2024-08-01 21:20:18.019864",
+            "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'

packages/datadog-api-client-v2/apis/WorkflowAutomationApi.ts

@@ -530,7 +530,7 @@ export class WorkflowAutomationApi {
   }
 
   /**
-   * 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 param The request object
    */
   public cancelWorkflowInstance(
@@ -552,7 +552,7 @@ export class WorkflowAutomationApi {
   }
 
   /**
-   * Execute the given workflow
+   * Execute the given workflow. This API requires an application key scoped with the workflows_run permission.
    * @param param The request object
    */
   public createWorkflowInstance(
@@ -574,7 +574,7 @@ export class WorkflowAutomationApi {
   }
 
   /**
-   * 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 param The request object
    */
   public getWorkflowInstance(
@@ -596,7 +596,7 @@ export class WorkflowAutomationApi {
   }
 
   /**
-   * 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 param The request object
    */
   public listWorkflowInstances(