Skip to content

Commit 8d11342

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add Actions API Access link to Action Platform APIs docs pages (#3047)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 3f91b67 commit 8d11342

File tree

4 files changed

+68
-17
lines changed

4 files changed

+68
-17
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46019,6 +46019,7 @@ paths:
4601946019
delete:
4602046020
description: Delete an existing Action Connection. This API requires a [registered
4602146021
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
46022+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4602246023
operationId: DeleteActionConnection
4602346024
parameters:
4602446025
- $ref: '#/components/parameters/ConnectionId'
@@ -47146,6 +47147,7 @@ paths:
4714647147
delete:
4714747148
description: Delete multiple apps in a single request from a list of app IDs.
4714847149
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47150+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4714947151
operationId: DeleteApps
4715047152
requestBody:
4715147153
content:
@@ -47192,6 +47194,7 @@ paths:
4719247194
is paginated. Only basic app information such as the app ID, name, and description
4719347195
is returned by this endpoint. This API requires a [registered application
4719447196
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47197+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4719547198
operationId: ListApps
4719647199
parameters:
4719747200
- description: The number of apps to return per page.
@@ -47299,6 +47302,7 @@ paths:
4729947302
post:
4730047303
description: Create a new app, returning the app ID. This API requires a [registered
4730147304
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47305+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4730247306
operationId: CreateApp
4730347307
requestBody:
4730447308
content:
@@ -47340,6 +47344,7 @@ paths:
4734047344
delete:
4734147345
description: Delete a single app. This API requires a [registered application
4734247346
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47347+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4734347348
operationId: DeleteApp
4734447349
parameters:
4734547350
- description: The ID of the app to delete.
@@ -47393,6 +47398,7 @@ paths:
4739347398
get:
4739447399
description: Get the full definition of an app. This API requires a [registered
4739547400
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47401+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4739647402
operationId: GetApp
4739747403
parameters:
4739847404
- description: The ID of the app to retrieve.
@@ -47456,6 +47462,7 @@ paths:
4745647462
patch:
4745747463
description: Update an existing app. This creates a new version of the app.
4745847464
This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47465+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4745947466
operationId: UpdateApp
4746047467
parameters:
4746147468
- description: The ID of the app to update.
@@ -47509,6 +47516,7 @@ paths:
4750947516
(`00000000-0000-0000-0000-000000000000`). The app can still be updated and
4751047517
published again in the future. This API requires a [registered application
4751147518
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47519+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4751247520
operationId: UnpublishApp
4751347521
parameters:
4751447522
- description: The ID of the app to unpublish.
@@ -47558,6 +47566,7 @@ paths:
4755847566
to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/)
4755947567
on the app if a policy does not yet exist. This API requires a [registered
4756047568
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
47569+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
4756147570
operationId: PublishApp
4756247571
parameters:
4756347572
- description: The ID of the app to publish.
@@ -68652,6 +68661,7 @@ paths:
6865268661
post:
6865368662
description: Create a new workflow, returning the workflow ID. This API requires
6865468663
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68664+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6865568665
operationId: CreateWorkflow
6865668666
requestBody:
6865768667
content:
@@ -68695,6 +68705,7 @@ paths:
6869568705
delete:
6869668706
description: Delete a workflow by ID. This API requires a [registered application
6869768707
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68708+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6869868709
operationId: DeleteWorkflow
6869968710
parameters:
6870068711
- $ref: '#/components/parameters/WorkflowId'
@@ -68729,6 +68740,7 @@ paths:
6872968740
get:
6873068741
description: Get a workflow by ID. This API requires a [registered application
6873168742
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68743+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6873268744
operationId: GetWorkflow
6873368745
parameters:
6873468746
- $ref: '#/components/parameters/WorkflowId'
@@ -68773,6 +68785,7 @@ paths:
6877368785
patch:
6877468786
description: Update a workflow by ID. This API requires a [registered application
6877568787
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68788+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6877668789
operationId: UpdateWorkflow
6877768790
parameters:
6877868791
- $ref: '#/components/parameters/WorkflowId'
@@ -68824,6 +68837,7 @@ paths:
6882468837
get:
6882568838
description: List all instances of a given workflow. This API requires a [registered
6882668839
application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68840+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6882768841
operationId: ListWorkflowInstances
6882868842
parameters:
6882968843
- $ref: '#/components/parameters/WorkflowId'
@@ -68857,6 +68871,7 @@ paths:
6885768871
post:
6885868872
description: Execute the given workflow. This API requires a [registered application
6885968873
key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68874+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6886068875
operationId: CreateWorkflowInstance
6886168876
parameters:
6886268877
- $ref: '#/components/parameters/WorkflowId'
@@ -68896,6 +68911,7 @@ paths:
6889668911
get:
6889768912
description: Get a specific execution of a given workflow. This API requires
6889868913
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68914+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6889968915
operationId: GetWorkflowInstance
6890068916
parameters:
6890168917
- $ref: '#/components/parameters/WorkflowId'
@@ -68931,6 +68947,7 @@ paths:
6893168947
put:
6893268948
description: Cancels a specific execution of a given workflow. This API requires
6893368949
a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
68950+
Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
6893468951
operationId: CancelWorkflowInstance
6893568952
parameters:
6893668953
- $ref: '#/components/parameters/WorkflowId'

src/main/java/com/datadog/api/client/v2/api/ActionConnectionApi.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,9 @@ public CompletableFuture<Void> deleteActionConnectionAsync(String connectionId)
219219
/**
220220
* Delete an existing Action Connection. This API requires a <a
221221
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
222-
* application key</a>.
222+
* application key</a>. Alternatively, you can configure these permissions <a
223+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
224+
* UI</a>.
223225
*
224226
* @param connectionId The ID of the action connection (required)
225227
* @return ApiResponse&lt;Void&gt;

src/main/java/com/datadog/api/client/v2/api/AppBuilderApi.java

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ public CompletableFuture<CreateAppResponse> createAppAsync(CreateAppRequest body
8888
/**
8989
* Create a new app, returning the app ID. This API requires a <a
9090
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
91-
* application key</a>.
91+
* application key</a>. Alternatively, you can configure these permissions <a
92+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
93+
* UI</a>.
9294
*
9395
* @param body (required)
9496
* @return ApiResponse&lt;CreateAppResponse&gt;
@@ -219,7 +221,9 @@ public CompletableFuture<DeleteAppResponse> deleteAppAsync(UUID appId) {
219221
/**
220222
* Delete a single app. This API requires a <a
221223
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
222-
* application key</a>.
224+
* application key</a>. Alternatively, you can configure these permissions <a
225+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
226+
* UI</a>.
223227
*
224228
* @param appId The ID of the app to delete. (required)
225229
* @return ApiResponse&lt;DeleteAppResponse&gt;
@@ -354,7 +358,9 @@ public CompletableFuture<DeleteAppsResponse> deleteAppsAsync(DeleteAppsRequest b
354358
/**
355359
* Delete multiple apps in a single request from a list of app IDs. This API requires a <a
356360
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
357-
* application key</a>.
361+
* application key</a>. Alternatively, you can configure these permissions <a
362+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
363+
* UI</a>.
358364
*
359365
* @param body (required)
360366
* @return ApiResponse&lt;DeleteAppsResponse&gt;
@@ -538,7 +544,9 @@ public CompletableFuture<GetAppResponse> getAppAsync(
538544
/**
539545
* Get the full definition of an app. This API requires a <a
540546
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
541-
* application key</a>.
547+
* application key</a>. Alternatively, you can configure these permissions <a
548+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
549+
* UI</a>.
542550
*
543551
* @param appId The ID of the app to retrieve. (required)
544552
* @param parameters Optional parameters for the request.
@@ -851,7 +859,9 @@ public CompletableFuture<ListAppsResponse> listAppsAsync(ListAppsOptionalParamet
851859
* information such as the app ID, name, and description is returned by this endpoint. This API
852860
* requires a <a
853861
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
854-
* application key</a>.
862+
* application key</a>. Alternatively, you can configure these permissions <a
863+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
864+
* UI</a>.
855865
*
856866
* @param parameters Optional parameters for the request.
857867
* @return ApiResponse&lt;ListAppsResponse&gt;
@@ -1022,7 +1032,9 @@ public CompletableFuture<PublishAppResponse> publishAppAsync(UUID appId) {
10221032
* href="https://docs.datadoghq.com/api/latest/restriction-policies/">Restriction Policy</a> on
10231033
* the app if a policy does not yet exist. This API requires a <a
10241034
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
1025-
* application key</a>.
1035+
* application key</a>. Alternatively, you can configure these permissions <a
1036+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
1037+
* UI</a>.
10261038
*
10271039
* @param appId The ID of the app to publish. (required)
10281040
* @return ApiResponse&lt;PublishAppResponse&gt;
@@ -1160,7 +1172,9 @@ public CompletableFuture<UnpublishAppResponse> unpublishAppAsync(UUID appId) {
11601172
* 00000000-0000-0000-0000-000000000000</code>). The app can still be updated and published again
11611173
* in the future. This API requires a <a
11621174
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
1163-
* application key</a>.
1175+
* application key</a>. Alternatively, you can configure these permissions <a
1176+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
1177+
* UI</a>.
11641178
*
11651179
* @param appId The ID of the app to unpublish. (required)
11661180
* @return ApiResponse&lt;UnpublishAppResponse&gt;
@@ -1300,7 +1314,9 @@ public CompletableFuture<UpdateAppResponse> updateAppAsync(UUID appId, UpdateApp
13001314
/**
13011315
* Update an existing app. This creates a new version of the app. This API requires a <a
13021316
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
1303-
* application key</a>.
1317+
* application key</a>. Alternatively, you can configure these permissions <a
1318+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
1319+
* UI</a>.
13041320
*
13051321
* @param appId The ID of the app to update. (required)
13061322
* @param body (required)

src/main/java/com/datadog/api/client/v2/api/WorkflowAutomationApi.java

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ public CompletableFuture<WorklflowCancelInstanceResponse> cancelWorkflowInstance
8989
/**
9090
* Cancels a specific execution of a given workflow. This API requires a <a
9191
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
92-
* application key</a>.
92+
* application key</a>. Alternatively, you can configure these permissions <a
93+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
94+
* UI</a>.
9395
*
9496
* @param workflowId The ID of the workflow. (required)
9597
* @param instanceId The ID of the workflow instance. (required)
@@ -255,7 +257,9 @@ public CompletableFuture<CreateWorkflowResponse> createWorkflowAsync(CreateWorkf
255257
/**
256258
* Create a new workflow, returning the workflow ID. This API requires a <a
257259
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
258-
* application key</a>.
260+
* application key</a>. Alternatively, you can configure these permissions <a
261+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
262+
* UI</a>.
259263
*
260264
* @param body (required)
261265
* @return ApiResponse&lt;CreateWorkflowResponse&gt;
@@ -392,7 +396,9 @@ public CompletableFuture<WorkflowInstanceCreateResponse> createWorkflowInstanceA
392396
/**
393397
* Execute the given workflow. This API requires a <a
394398
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
395-
* application key</a>.
399+
* application key</a>. Alternatively, you can configure these permissions <a
400+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
401+
* UI</a>.
396402
*
397403
* @param workflowId The ID of the workflow. (required)
398404
* @param body (required)
@@ -552,7 +558,9 @@ public CompletableFuture<Void> deleteWorkflowAsync(String workflowId) {
552558
/**
553559
* Delete a workflow by ID. This API requires a <a
554560
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
555-
* application key</a>.
561+
* application key</a>. Alternatively, you can configure these permissions <a
562+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
563+
* UI</a>.
556564
*
557565
* @param workflowId The ID of the workflow. (required)
558566
* @return ApiResponse&lt;Void&gt;
@@ -689,7 +697,9 @@ public CompletableFuture<GetWorkflowResponse> getWorkflowAsync(String workflowId
689697
/**
690698
* Get a workflow by ID. This API requires a <a
691699
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
692-
* application key</a>.
700+
* application key</a>. Alternatively, you can configure these permissions <a
701+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
702+
* UI</a>.
693703
*
694704
* @param workflowId The ID of the workflow. (required)
695705
* @return ApiResponse&lt;GetWorkflowResponse&gt;
@@ -833,7 +843,9 @@ public CompletableFuture<WorklflowGetInstanceResponse> getWorkflowInstanceAsync(
833843
/**
834844
* Get a specific execution of a given workflow. This API requires a <a
835845
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
836-
* application key</a>.
846+
* application key</a>. Alternatively, you can configure these permissions <a
847+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
848+
* UI</a>.
837849
*
838850
* @param workflowId The ID of the workflow. (required)
839851
* @param instanceId The ID of the workflow instance. (required)
@@ -1064,7 +1076,9 @@ public CompletableFuture<WorkflowListInstancesResponse> listWorkflowInstancesAsy
10641076
/**
10651077
* List all instances of a given workflow. This API requires a <a
10661078
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
1067-
* application key</a>.
1079+
* application key</a>. Alternatively, you can configure these permissions <a
1080+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
1081+
* UI</a>.
10681082
*
10691083
* @param workflowId The ID of the workflow. (required)
10701084
* @param parameters Optional parameters for the request.
@@ -1225,7 +1239,9 @@ public CompletableFuture<UpdateWorkflowResponse> updateWorkflowAsync(
12251239
/**
12261240
* Update a workflow by ID. This API requires a <a
12271241
* href="https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key">registered
1228-
* application key</a>.
1242+
* application key</a>. Alternatively, you can configure these permissions <a
1243+
* href="https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access">in the
1244+
* UI</a>.
12291245
*
12301246
* @param workflowId The ID of the workflow. (required)
12311247
* @param body (required)

0 commit comments

Comments
 (0)