Add trigger API documentation for workflow automation (#2034)

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>

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-30 17:56:17.160652",
-            "spec_repo_commit": "4380003d"
+            "regenerated": "2024-07-30 19:24:55.550204",
+            "spec_repo_commit": "edbd396a"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-30 17:56:17.178544",
-            "spec_repo_commit": "4380003d"
+            "regenerated": "2024-07-30 19:24:55.567305",
+            "spec_repo_commit": "edbd396a"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -358,6 +358,13 @@ components:
       required: true
       schema:
         type: string
+    InstanceId:
+      description: The ID of the workflow instance.
+      in: path
+      name: instance_id
+      required: true
+      schema:
+        type: string
     MetricID:
       description: The name of the log-based metric.
       in: path
@@ -543,6 +550,13 @@ components:
       schema:
         example: 00000000-0000-9999-0000-000000000000
         type: string
+    WorkflowId:
+      description: The ID of the workflow.
+      in: path
+      name: workflow_id
+      required: true
+      schema:
+        type: string
   requestBodies: {}
   responses:
     BadRequestResponse:
@@ -23831,6 +23845,107 @@ components:
       - PAST_SIX_MONTHS
       - PAST_ONE_YEAR
       - ALERT
+    WorkflowInstanceCreateMeta:
+      description: Additional information for creating a workflow instance.
+      properties:
+        payload:
+          additionalProperties: {}
+          description: The input parameters to the workflow.
+          type: object
+      type: object
+    WorkflowInstanceCreateRequest:
+      description: Request used to create a workflow instance.
+      properties:
+        meta:
+          $ref: '#/components/schemas/WorkflowInstanceCreateMeta'
+      type: object
+    WorkflowInstanceCreateResponse:
+      additionalProperties: {}
+      description: Response returned upon successful workflow instance creation.
+      properties:
+        data:
+          $ref: '#/components/schemas/WorkflowInstanceCreateResponseData'
+      type: object
+    WorkflowInstanceCreateResponseData:
+      additionalProperties: {}
+      description: Data about the created workflow instance.
+      properties:
+        id:
+          description: The ID of the workflow execution. It can be used to fetch the
+            execution status.
+          type: string
+      type: object
+    WorkflowInstanceListItem:
+      additionalProperties: {}
+      description: An item in the workflow instances list.
+      properties:
+        id:
+          description: The ID of the workflow instance
+          type: string
+      type: object
+    WorkflowListInstancesResponse:
+      additionalProperties: {}
+      description: Response returned when listing workflow instances.
+      properties:
+        data:
+          description: A list of workflow instances.
+          items:
+            $ref: '#/components/schemas/WorkflowInstanceListItem'
+          type: array
+        meta:
+          $ref: '#/components/schemas/WorkflowListInstancesResponseMeta'
+      type: object
+    WorkflowListInstancesResponseMeta:
+      additionalProperties: {}
+      description: Metadata about the instances list
+      properties:
+        page:
+          $ref: '#/components/schemas/WorkflowListInstancesResponseMetaPage'
+      type: object
+    WorkflowListInstancesResponseMetaPage:
+      additionalProperties: {}
+      description: Page information for the list instances response.
+      properties:
+        totalCount:
+          description: The total count of items.
+          format: int64
+          type: integer
+      type: object
+    WorklflowCancelInstanceResponse:
+      description: Information about the canceled instance.
+      properties:
+        data:
+          $ref: '#/components/schemas/WorklflowCancelInstanceResponseData'
+      type: object
+    WorklflowCancelInstanceResponseData:
+      description: Data about the canceled instance.
+      properties:
+        id:
+          description: The id of the canceled instance
+          type: string
+      type: object
+    WorklflowGetInstanceResponse:
+      additionalProperties: {}
+      description: The state of the given workflow instance.
+      properties:
+        data:
+          $ref: '#/components/schemas/WorklflowGetInstanceResponseData'
+      type: object
+    WorklflowGetInstanceResponseData:
+      additionalProperties: {}
+      description: The data of the instance response.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes'
+      type: object
+    WorklflowGetInstanceResponseDataAttributes:
+      additionalProperties: {}
+      description: The attributes of the instance response data.
+      properties:
+        id:
+          description: The id of the instance.
+          type: string
+      type: object
   securitySchemes:
     AuthZ:
       description: This API uses OAuth 2 with the implicit grant flow.
@@ -37850,6 +37965,108 @@ paths:
       summary: Get user memberships
       tags:
       - Teams
+  /api/v2/workflows/{workflow_id}/instances:
+    get:
+      description: List all instances of a given workflow.
+      operationId: ListWorkflowInstances
+      parameters:
+      - $ref: '#/components/parameters/WorkflowId'
+      - $ref: '#/components/parameters/PageSize'
+      - $ref: '#/components/parameters/PageNumber'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorkflowListInstancesResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: List workflow instances
+      tags:
+      - Workflow Automation
+    post:
+      description: Execute the given workflow
+      operationId: CreateWorkflowInstance
+      parameters:
+      - $ref: '#/components/parameters/WorkflowId'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/WorkflowInstanceCreateRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorkflowInstanceCreateResponse'
+          description: Created
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Execute a workflow
+      tags:
+      - Workflow Automation
+      x-codegen-request-body-name: body
+  /api/v2/workflows/{workflow_id}/instances/{instance_id}:
+    get:
+      description: Get a specific execution of a given workflow.
+      operationId: GetWorkflowInstance
+      parameters:
+      - $ref: '#/components/parameters/WorkflowId'
+      - $ref: '#/components/parameters/InstanceId'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorklflowGetInstanceResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Get a workflow instance
+      tags:
+      - Workflow Automation
+  /api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
+    put:
+      description: Cancels a specific execution of a given workflow.
+      operationId: CancelWorkflowInstance
+      parameters:
+      - $ref: '#/components/parameters/WorkflowId'
+      - $ref: '#/components/parameters/InstanceId'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/WorklflowCancelInstanceResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Cancel a workflow instance
+      tags:
+      - Workflow Automation
 security:
 - apiKeyAuth: []
   appKeyAuth: []
@@ -38221,4 +38438,9 @@ tags:
   externalDocs:
     url: https://docs.datadoghq.com/account_management/users
   name: Users
+- description: Automate your teams operational processes with Datadog Workflow Automation.
+  externalDocs:
+    description: Find out more at
+    url: https://docs.datadoghq.com/service_management/workflows/
+  name: Workflow Automation
 x-group-parameters: true

docs/datadog_api_client.v2.api.rst

@@ -361,6 +361,13 @@ datadog\_api\_client.v2.api.users\_api module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.api.workflow\_automation\_api module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.api.workflow_automation_api
+   :members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

docs/datadog_api_client.v2.model.rst

@@ -10721,6 +10721,97 @@ datadog\_api\_client.v2.model.widget\_live\_span module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.workflow\_instance\_create\_meta module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_instance_create_meta
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_instance\_create\_request module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_instance_create_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_instance\_create\_response module
+-------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_instance_create_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_instance\_create\_response\_data module
+-------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_instance_create_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_instance\_list\_item module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_instance_list_item
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_list\_instances\_response module
+------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_list_instances_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_list\_instances\_response\_meta module
+------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_list_instances_response_meta
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.workflow\_list\_instances\_response\_meta\_page module
+------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.workflow_list_instances_response_meta_page
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.worklflow\_cancel\_instance\_response module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.worklflow_cancel_instance_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.worklflow\_cancel\_instance\_response\_data module
+--------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.worklflow_cancel_instance_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.worklflow\_get\_instance\_response module
+-----------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.worklflow_get_instance_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.worklflow\_get\_instance\_response\_data module
+-----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.worklflow_get_instance_response_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.worklflow\_get\_instance\_response\_data\_attributes module
+-----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.worklflow_get_instance_response_data_attributes
+   :members:
+   :show-inheritance:
+
 Module contents
 ---------------