Skip to content

Commit 7cad737

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 41320e4a of spec repo
1 parent 3fea1f4 commit 7cad737

File tree

49 files changed

+6619
-4992
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+6619
-4992
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-07-26 19:06:13.301282",
8-
"spec_repo_commit": "44cf4afe"
7+
"regenerated": "2024-07-26 19:59:00.713526",
8+
"spec_repo_commit": "41320e4a"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-07-26 19:06:13.318622",
13-
"spec_repo_commit": "44cf4afe"
12+
"regenerated": "2024-07-26 19:59:00.730612",
13+
"spec_repo_commit": "41320e4a"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -358,6 +358,13 @@ components:
358358
required: true
359359
schema:
360360
type: string
361+
InstanceId:
362+
description: The ID of the workflow instance.
363+
in: path
364+
name: instance_id
365+
required: true
366+
schema:
367+
type: string
361368
MetricID:
362369
description: The name of the log-based metric.
363370
in: path
@@ -543,6 +550,13 @@ components:
543550
schema:
544551
example: 00000000-0000-9999-0000-000000000000
545552
type: string
553+
WorkflowId:
554+
description: The ID of the workflow.
555+
in: path
556+
name: workflow_id
557+
required: true
558+
schema:
559+
type: string
546560
requestBodies: {}
547561
responses:
548562
BadRequestResponse:
@@ -23829,6 +23843,89 @@ components:
2382923843
- PAST_SIX_MONTHS
2383023844
- PAST_ONE_YEAR
2383123845
- ALERT
23846+
WorkflowInstanceCreateMeta:
23847+
description: Additional information for creating a workflow instance.
23848+
properties:
23849+
payload:
23850+
additionalProperties: {}
23851+
description: The input parameters to the workflow.
23852+
type: object
23853+
type: object
23854+
WorkflowInstanceCreateRequest:
23855+
description: Request used to create a workflow instance.
23856+
properties:
23857+
meta:
23858+
$ref: '#/components/schemas/WorkflowInstanceCreateMeta'
23859+
type: object
23860+
WorkflowInstanceCreateResponse:
23861+
additionalProperties: {}
23862+
description: Response returned upon successful workflow instance creation.
23863+
properties:
23864+
data:
23865+
$ref: '#/components/schemas/WorkflowInstanceCreateResponseData'
23866+
type: object
23867+
WorkflowInstanceCreateResponseData:
23868+
additionalProperties: {}
23869+
description: Data about the created workflow instance.
23870+
properties:
23871+
id:
23872+
description: The ID of the workflow execution. It can be used to fetch the
23873+
execution status.
23874+
type: string
23875+
type: object
23876+
WorkflowInstanceListItem:
23877+
additionalProperties: {}
23878+
description: An item in the workflow instances list.
23879+
properties:
23880+
id:
23881+
description: The ID of the workflow instance
23882+
type: string
23883+
type: object
23884+
WorkflowListInstancesResponse:
23885+
additionalProperties: {}
23886+
description: Response returned when listing workflow instances.
23887+
properties:
23888+
data:
23889+
description: A list of workflow instances.
23890+
items:
23891+
$ref: '#/components/schemas/WorkflowInstanceListItem'
23892+
type: array
23893+
type: object
23894+
WorklflowCancelInstanceResponse:
23895+
description: Information about the canceled instance.
23896+
properties:
23897+
data:
23898+
$ref: '#/components/schemas/WorklflowCancelInstanceResponseData'
23899+
type: object
23900+
WorklflowCancelInstanceResponseData:
23901+
description: Data about the canceled instance.
23902+
properties:
23903+
id:
23904+
description: The id of the canceled instance
23905+
type: string
23906+
type: object
23907+
WorklflowGetInstanceResponse:
23908+
additionalProperties: {}
23909+
description: The state of the given workflow instance.
23910+
properties:
23911+
data:
23912+
$ref: '#/components/schemas/WorklflowGetInstanceResponseData'
23913+
type: object
23914+
WorklflowGetInstanceResponseData:
23915+
additionalProperties: {}
23916+
description: The data of the instance response.
23917+
properties:
23918+
attributes:
23919+
$ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes'
23920+
type: object
23921+
WorklflowGetInstanceResponseDataAttributes:
23922+
additionalProperties: {}
23923+
description: The attributes of the instance response data.
23924+
properties:
23925+
id:
23926+
description: The id of the instance.
23927+
type: string
23928+
type: object
2383223929
securitySchemes:
2383323930
AuthZ:
2383423931
description: This API uses OAuth 2 with the implicit grant flow.
@@ -37848,6 +37945,148 @@ paths:
3784837945
summary: Get user memberships
3784937946
tags:
3785037947
- Teams
37948+
/api/v2/workflows/{workflow_id}/instances:
37949+
get:
37950+
description: List all instances of a given workflow.
37951+
operationId: ListWorkflowInstances
37952+
parameters:
37953+
- $ref: '#/components/parameters/WorkflowId'
37954+
- $ref: '#/components/parameters/PageSize'
37955+
- $ref: '#/components/parameters/PageNumber'
37956+
responses:
37957+
'200':
37958+
content:
37959+
application/json:
37960+
schema:
37961+
$ref: '#/components/schemas/WorkflowListInstancesResponse'
37962+
description: OK
37963+
'400':
37964+
content:
37965+
application/json:
37966+
schema:
37967+
$ref: '#/components/schemas/APIErrorResponse'
37968+
description: Bad Request
37969+
'403':
37970+
content:
37971+
application/json:
37972+
schema:
37973+
$ref: '#/components/schemas/APIErrorResponse'
37974+
description: Forbidden
37975+
'429':
37976+
$ref: '#/components/responses/TooManyRequestsResponse'
37977+
summary: List workflow instances
37978+
tags:
37979+
- Workflow Automation
37980+
post:
37981+
description: Execute the given workflow
37982+
operationId: CreateWorkflowInstance
37983+
parameters:
37984+
- $ref: '#/components/parameters/WorkflowId'
37985+
requestBody:
37986+
content:
37987+
application/json:
37988+
schema:
37989+
$ref: '#/components/schemas/WorkflowInstanceCreateRequest'
37990+
required: true
37991+
responses:
37992+
'200':
37993+
content:
37994+
application/json:
37995+
schema:
37996+
$ref: '#/components/schemas/WorkflowInstanceCreateResponse'
37997+
description: Created
37998+
'400':
37999+
content:
38000+
application/json:
38001+
schema:
38002+
$ref: '#/components/schemas/APIErrorResponse'
38003+
description: Bad Request
38004+
'403':
38005+
content:
38006+
application/json:
38007+
schema:
38008+
$ref: '#/components/schemas/APIErrorResponse'
38009+
description: Forbidden
38010+
'429':
38011+
$ref: '#/components/responses/TooManyRequestsResponse'
38012+
summary: Execute a workflow
38013+
tags:
38014+
- Workflow Automation
38015+
x-codegen-request-body-name: body
38016+
/api/v2/workflows/{workflow_id}/instances/{instance_id}:
38017+
get:
38018+
description: Get a specific execution of a given workflow.
38019+
operationId: GetWorkflowInstance
38020+
parameters:
38021+
- $ref: '#/components/parameters/WorkflowId'
38022+
- $ref: '#/components/parameters/InstanceId'
38023+
responses:
38024+
'200':
38025+
content:
38026+
application/json:
38027+
schema:
38028+
$ref: '#/components/schemas/WorklflowGetInstanceResponse'
38029+
description: OK
38030+
'400':
38031+
content:
38032+
application/json:
38033+
schema:
38034+
$ref: '#/components/schemas/APIErrorResponse'
38035+
description: Bad Request
38036+
'403':
38037+
content:
38038+
application/json:
38039+
schema:
38040+
$ref: '#/components/schemas/APIErrorResponse'
38041+
description: Forbidden
38042+
'404':
38043+
content:
38044+
application/json:
38045+
schema:
38046+
$ref: '#/components/schemas/APIErrorResponse'
38047+
description: Not Found
38048+
'429':
38049+
$ref: '#/components/responses/TooManyRequestsResponse'
38050+
summary: Get a workflow instance
38051+
tags:
38052+
- Workflow Automation
38053+
/api/v2/workflows/{workflow_id}/instances/{instance_id}/cancel:
38054+
put:
38055+
description: Cancels a specific execution of a given workflow.
38056+
operationId: CancelWorkflowInstance
38057+
parameters:
38058+
- $ref: '#/components/parameters/WorkflowId'
38059+
- $ref: '#/components/parameters/InstanceId'
38060+
responses:
38061+
'200':
38062+
content:
38063+
application/json:
38064+
schema:
38065+
$ref: '#/components/schemas/WorklflowCancelInstanceResponse'
38066+
description: OK
38067+
'400':
38068+
content:
38069+
application/json:
38070+
schema:
38071+
$ref: '#/components/schemas/APIErrorResponse'
38072+
description: Bad Request
38073+
'403':
38074+
content:
38075+
application/json:
38076+
schema:
38077+
$ref: '#/components/schemas/APIErrorResponse'
38078+
description: Forbidden
38079+
'404':
38080+
content:
38081+
application/json:
38082+
schema:
38083+
$ref: '#/components/schemas/APIErrorResponse'
38084+
description: Not Found
38085+
'429':
38086+
$ref: '#/components/responses/TooManyRequestsResponse'
38087+
summary: Cancel a workflow instance
38088+
tags:
38089+
- Workflow Automation
3785138090
security:
3785238091
- apiKeyAuth: []
3785338092
appKeyAuth: []
@@ -38219,4 +38458,9 @@ tags:
3821938458
externalDocs:
3822038459
url: https://docs.datadoghq.com/account_management/users
3822138460
name: Users
38461+
- description: Automate your teams operational processes with Datadog Workflow Automation.
38462+
externalDocs:
38463+
description: Find out more at
38464+
url: https://docs.datadoghq.com/service_management/workflows/
38465+
name: Workflow Automation
3822238466
x-group-parameters: true

docs/datadog_api_client.rst

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,55 @@
1-
datadog\_api\_client
2-
====================
1+
datadog\_api\_client package
2+
============================
3+
4+
Subpackages
5+
-----------
36

47
.. toctree::
58
:maxdepth: 4
69

710
datadog_api_client.v1
811
datadog_api_client.v2
912

13+
Submodules
14+
----------
1015

11-
api\_client
12-
-----------
16+
datadog\_api\_client.api\_client module
17+
---------------------------------------
1318

1419
.. automodule:: datadog_api_client.api_client
1520
:members:
1621
:show-inheritance:
1722

18-
configuration
19-
-------------
23+
datadog\_api\_client.configuration module
24+
-----------------------------------------
2025

2126
.. automodule:: datadog_api_client.configuration
2227
:members:
2328
:show-inheritance:
2429

25-
exceptions
26-
----------
30+
datadog\_api\_client.exceptions module
31+
--------------------------------------
2732

2833
.. automodule:: datadog_api_client.exceptions
2934
:members:
3035
:show-inheritance:
3136

32-
model\_utils
33-
------------
37+
datadog\_api\_client.model\_utils module
38+
----------------------------------------
3439

3540
.. automodule:: datadog_api_client.model_utils
3641
:members:
3742
:show-inheritance:
3843

39-
rest
40-
----
44+
datadog\_api\_client.rest module
45+
--------------------------------
4146

4247
.. automodule:: datadog_api_client.rest
4348
:members:
4449
:show-inheritance:
4550

51+
Module contents
52+
---------------
4653

4754
.. automodule:: datadog_api_client
4855
:members:

0 commit comments

Comments
 (0)