Skip to content

Commit 5453d0b

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

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'

src/datadog_api_client/v2/api/action_connection_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ def delete_action_connection(
248248
) -> None:
249249
"""Delete an existing Action Connection.
250250
251-
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>`_.
251+
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>`_.
252252
253253
:param connection_id: The ID of the action connection
254254
:type connection_id: str

src/datadog_api_client/v2/api/app_builder_api.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ def create_app(
278278
) -> CreateAppResponse:
279279
"""Create App.
280280
281-
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>`_.
281+
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>`_.
282282
283283
:type body: CreateAppRequest
284284
:rtype: CreateAppResponse
@@ -294,7 +294,7 @@ def delete_app(
294294
) -> DeleteAppResponse:
295295
"""Delete App.
296296
297-
Delete a single app. This API requires a `registered application key <https://docs.datadoghq.com/api/latest/action-connection/#register-a-new-app-key>`_.
297+
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>`_.
298298
299299
:param app_id: The ID of the app to delete.
300300
:type app_id: UUID
@@ -311,7 +311,7 @@ def delete_apps(
311311
) -> DeleteAppsResponse:
312312
"""Delete Multiple Apps.
313313
314-
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>`_.
314+
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>`_.
315315
316316
:type body: DeleteAppsRequest
317317
:rtype: DeleteAppsResponse
@@ -329,7 +329,7 @@ def get_app(
329329
) -> GetAppResponse:
330330
"""Get App.
331331
332-
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>`_.
332+
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>`_.
333333
334334
:param app_id: The ID of the app to retrieve.
335335
:type app_id: UUID
@@ -362,7 +362,7 @@ def list_apps(
362362
) -> ListAppsResponse:
363363
"""List Apps.
364364
365-
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>`_.
365+
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>`_.
366366
367367
:param limit: The number of apps to return per page.
368368
:type limit: int, optional
@@ -430,7 +430,7 @@ def publish_app(
430430
) -> PublishAppResponse:
431431
"""Publish App.
432432
433-
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>`_.
433+
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>`_.
434434
435435
:param app_id: The ID of the app to publish.
436436
:type app_id: UUID
@@ -447,7 +447,7 @@ def unpublish_app(
447447
) -> UnpublishAppResponse:
448448
"""Unpublish App.
449449
450-
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>`_.
450+
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>`_.
451451
452452
:param app_id: The ID of the app to unpublish.
453453
:type app_id: UUID
@@ -465,7 +465,7 @@ def update_app(
465465
) -> UpdateAppResponse:
466466
"""Update App.
467467
468-
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>`_.
468+
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>`_.
469469
470470
:param app_id: The ID of the app to update.
471471
:type app_id: UUID

0 commit comments

Comments
 (0)