Skip to content

Commit 230311f

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

File tree

4 files changed

+34
-17
lines changed

4 files changed

+34
-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'

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -949,7 +949,7 @@ export class ActionConnectionApi {
949949
}
950950

951951
/**
952-
* Delete an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
952+
* Delete an existing Action Connection. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
953953
* @param param The request object
954954
*/
955955
public deleteActionConnection(

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1228,7 +1228,7 @@ export class AppBuilderApi {
12281228
}
12291229

12301230
/**
1231-
* Create a new app, returning the app ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1231+
* Create a new app, returning the app ID. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
12321232
* @param param The request object
12331233
*/
12341234
public createApp(
@@ -1249,7 +1249,7 @@ export class AppBuilderApi {
12491249
}
12501250

12511251
/**
1252-
* Delete a single app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1252+
* Delete a single app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
12531253
* @param param The request object
12541254
*/
12551255
public deleteApp(
@@ -1270,7 +1270,7 @@ export class AppBuilderApi {
12701270
}
12711271

12721272
/**
1273-
* Delete multiple apps in a single request from a list of app IDs. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1273+
* Delete multiple apps in a single request from a list of app IDs. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
12741274
* @param param The request object
12751275
*/
12761276
public deleteApps(
@@ -1291,7 +1291,7 @@ export class AppBuilderApi {
12911291
}
12921292

12931293
/**
1294-
* Get the full definition of an app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1294+
* Get the full definition of an app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
12951295
* @param param The request object
12961296
*/
12971297
public getApp(
@@ -1313,7 +1313,7 @@ export class AppBuilderApi {
13131313
}
13141314

13151315
/**
1316-
* List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1316+
* List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
13171317
* @param param The request object
13181318
*/
13191319
public listApps(
@@ -1344,7 +1344,7 @@ export class AppBuilderApi {
13441344
}
13451345

13461346
/**
1347-
* Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1347+
* Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a [Restriction Policy](https://docs.datadoghq.com/api/latest/restriction-policies/) on the app if a policy does not yet exist. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
13481348
* @param param The request object
13491349
*/
13501350
public publishApp(
@@ -1365,7 +1365,7 @@ export class AppBuilderApi {
13651365
}
13661366

13671367
/**
1368-
* Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1368+
* Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a `deployment` object on the app, with a nil `app_version_id` (`00000000-0000-0000-0000-000000000000`). The app can still be updated and published again in the future. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
13691369
* @param param The request object
13701370
*/
13711371
public unpublishApp(
@@ -1386,7 +1386,7 @@ export class AppBuilderApi {
13861386
}
13871387

13881388
/**
1389-
* Update an existing app. This creates a new version of the app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key).
1389+
* Update an existing app. This creates a new version of the app. This API requires a [registered application key](https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key). Alternatively, you can configure these permissions [in the UI](https://docs.datadoghq.com/account_management/api-app-keys/#actions-api-access).
13901390
* @param param The request object
13911391
*/
13921392
public updateApp(

0 commit comments

Comments
 (0)