Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2053,7 +2053,7 @@ components:
type: string
ResourceID:
description: |-
Identifier, formatted as `type:id`. Supported types: `ai-gateway-provider`, `ai-gateway-route`, `dashboard`, `integration-service`, `integration-webhook`, `notebook`, `powerpack`, `reference-table`, `security-rule`, `slo`, `synthetics-global-variable`, `synthetics-test`, `synthetics-private-location`, `monitor`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`, `cross-org-connection`, `spreadsheet`, `on-call-schedule`, `on-call-escalation-policy`, `on-call-team-routing-rules`, `logs-pipeline`, `case-management-project`, `monitor-notification-rule`, `status-page`, `feature-flag`, `network-path-config`.
Identifier, formatted as `type:id`. Supported types: `ai-gateway-provider`, `ai-gateway-route`, `ai-gateway-capture-override`, `dashboard`, `integration-service`, `integration-webhook`, `notebook`, `powerpack`, `reference-table`, `security-rule`, `slo`, `synthetics-global-variable`, `synthetics-test`, `synthetics-private-location`, `monitor`, `workflow`, `app-builder-app`, `connection`, `connection-group`, `rum-application`, `cross-org-connection`, `spreadsheet`, `on-call-schedule`, `on-call-escalation-policy`, `on-call-team-routing-rules`, `logs-pipeline`, `case-management-project`, `monitor-notification-rule`, `status-page`, `feature-flag`, `network-path-config`.
example: "dashboard:abc-def-ghi"
in: path
name: resource_id
Expand Down Expand Up @@ -8825,7 +8825,7 @@ components:
description: Organization default mode, scoped overrides, and current configuration revision.
properties:
configuration_revision:
description: Opaque revision of the organization default and all overrides. Writes require the revision returned by a current read or preview.
description: Opaque revision of the organization default and all overrides, including hidden overrides. Writes require the revision returned by a current read or preview.
example: "capture-revision-1"
type: string
default_metadata_capture:
Expand All @@ -8835,7 +8835,7 @@ components:
default_mode:
$ref: "#/components/schemas/AiGatewayCaptureConfigurationResponseDataAttributesDefaultMode"
overrides:
description: Scoped overrides currently configured for the organization.
description: Overrides the caller can View. Hidden overrides still apply to traffic; an empty list does not prove that no overrides exist.
items:
$ref: "#/components/schemas/AiGatewayCaptureOverride"
type: array
Expand Down Expand Up @@ -8892,7 +8892,7 @@ components:
description: Settings and configuration revision for creating the override.
properties:
configuration_revision:
description: Opaque revision of the organization default and all overrides. Writes require the revision returned by a current read or preview.
description: Opaque revision of the organization default and all overrides, including hidden overrides. Writes require the revision returned by a current read or preview.
example: "capture-revision-1"
type: string
confirm_full_capture:
Expand Down Expand Up @@ -8986,7 +8986,7 @@ components:
description: Revisions and confirmation used to delete the override.
properties:
configuration_revision:
description: Opaque revision of the organization default and all overrides. Writes require the revision returned by a current read or preview.
description: Opaque revision of the organization default and all overrides, including hidden overrides. Writes require the revision returned by a current read or preview.
example: "capture-revision-1"
type: string
confirm_full_capture:
Expand Down Expand Up @@ -9260,7 +9260,7 @@ components:
description: Replacement settings and revisions for updating the override.
properties:
configuration_revision:
description: Opaque revision of the organization default and all overrides. Writes require the revision returned by a current read or preview.
description: Opaque revision of the organization default and all overrides, including hidden overrides. Writes require the revision returned by a current read or preview.
example: "capture-revision-1"
type: string
confirm_full_capture:
Expand Down Expand Up @@ -178200,7 +178200,7 @@ paths:
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/data-capture/configuration:
get:
description: Get the organization default mode, scoped capture overrides, and configuration revision.
description: Get the organization default mode, scoped capture overrides, and configuration revision. Requires `ai_gateway_config_read`. Only overrides the caller can View are returned. Hidden overrides remain effective and contribute to `configuration_revision`. An override missing from the response is not necessarily deleted.
operationId: GetAiGatewayDataCaptureConfiguration
responses:
"200":
Expand Down Expand Up @@ -178247,7 +178247,7 @@ paths:
x-unstable: "**Note**: This endpoint is in Preview and is subject to change.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)."
/api/v2/data-capture/overrides:
post:
description: Create a scoped override with a client-generated UUID and the current `configuration_revision`. If the override can enable full capture for more traffic, set `confirm_full_capture` to `true`. Returns HTTP 409 when `configuration_revision` is stale, the UUID already exists, or the organization has 100 overrides. Missing `configuration_revision` or required full-capture confirmation returns HTTP 400. Retrying an accepted create with the same UUID returns HTTP 409. To undo a create, read the current configuration revision and delete the override using its returned override revision.
description: Create a scoped override with a client-generated UUID and the current `configuration_revision`. If the override can enable full capture for more traffic, set `confirm_full_capture` to `true`. Returns HTTP 409 when `configuration_revision` is stale, the UUID already exists, or the organization has 100 overrides. Missing `configuration_revision` or required full-capture confirmation returns HTTP 400. Retrying an accepted create with the same UUID returns HTTP 409. To undo a create, read the current configuration revision and delete the override using its returned override revision. Requires `ai_gateway_config_write`. Restriction policies are saved separately after the returned UUID and revision acknowledge creation. A lost response is an unknown outcome; absence from a filtered configuration response does not prove creation failed.
operationId: CreateAiGatewayDataCaptureOverride
requestBody:
content:
Expand Down Expand Up @@ -178299,7 +178299,7 @@ paths:
x-unstable: "**Note**: This endpoint is in Preview and is subject to change.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)."
/api/v2/data-capture/overrides/{id}:
delete:
description: Delete an override using its `revision` and the current `configuration_revision`. If deleting the override can enable full capture for affected traffic, set `confirm_full_capture` to `true`. Returns HTTP 409 when `configuration_revision` or the override `revision` is stale, including a concurrent change during deletion. Missing revisions or required full-capture confirmation returns HTTP 400.
description: Delete an override using its `revision` and the current `configuration_revision`. If deleting the override can enable full capture for affected traffic, set `confirm_full_capture` to `true`. Returns HTTP 409 when `configuration_revision` or the override `revision` is stale, including a concurrent change during deletion. Missing revisions or required full-capture confirmation returns HTTP 400. Requires `ai_gateway_config_write` and View and Edit access to this override. Hidden overrides return HTTP 404; visible overrides without Edit return HTTP 403. Authorization failures return HTTP 503. If permission cleanup fails after the deletion is committed, the response is HTTP 500 with code `deletion_permission_cleanup_failed`, `meta.configuration_deleted=true`, and `meta.permissions_cleanup_failed=true`. Do not retry the deletion.
operationId: DeleteAiGatewayDataCaptureOverride
parameters:
- description: Data capture override ID.
Expand Down Expand Up @@ -178344,7 +178344,7 @@ paths:
- ai_gateway_config_write
x-unstable: "**Note**: This endpoint is in Preview and is subject to change.\nIf you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/)."
put:
description: Replace an override using its `revision` and the current `configuration_revision`. Changes to capture overrides don't affect routing rules. Returns HTTP 409 when `configuration_revision` or the override `revision` is stale, including a concurrent change during replacement. Missing revisions or required full-capture confirmation returns HTTP 400.
description: Replace an override using its `revision` and the current `configuration_revision`. Changes to capture overrides don't affect routing rules. Returns HTTP 409 when `configuration_revision` or the override `revision` is stale, including a concurrent change during replacement. Missing revisions or required full-capture confirmation returns HTTP 400. Requires `ai_gateway_config_write` and View and Edit access to this override. Hidden overrides return HTTP 404; visible overrides without Edit return HTTP 403. Authorization failures return HTTP 503. The returned UUID and revision acknowledge the saved configuration even if the caller can no longer list it. Restriction policies are saved separately.
operationId: UpdateAiGatewayDataCaptureOverride
parameters:
- description: Data capture override ID.
Expand Down Expand Up @@ -235446,6 +235446,7 @@ paths:
Restriction policies can be applied to the following resources:
- AI Gateway Providers: `ai-gateway-provider`
- AI Gateway Routes: `ai-gateway-route`
- AI Gateway Capture Overrides: `ai-gateway-capture-override`
- Dashboards: `dashboard`
- Integration Services: `integration-service`
- Integration Webhooks: `integration-webhook`
Expand Down Expand Up @@ -235476,17 +235477,19 @@ paths:
- Network Path Configs: `network-path-config`

AI Gateway provider policies control configuration and inherited model/catalog/pricing visibility. Route policies control route configuration and identifying nested references.
The editor relation includes View. Providers and routes have no Run relation; restriction policies don't affect inference.
Reading provider or route policies requires `ai_gateway_config_read`. Updating or deleting them requires
Capture override policies control who can view and edit override configuration. Hidden overrides remain effective for traffic.
The editor relation includes View. Providers, routes, and capture overrides have no Run relation; restriction policies don't affect inference.
Reading provider, route, or capture override policies requires `ai_gateway_config_read`. Updating or deleting them requires
`ai_gateway_config_write` and follows standard restriction-policy authorization, including
administrator recovery and self-lockout checks.
Providers and routes without a restriction policy retain the normal unrestricted defaults.
Providers, routes, and capture overrides without a restriction policy retain the normal unrestricted defaults.

#### Supported relations for resources
Resource Type | Supported Relations
----------------------------|--------------------------
AI Gateway Providers | `viewer`, `editor`
AI Gateway Routes | `viewer`, `editor`
AI Gateway Capture Overrides | `viewer`, `editor`
Dashboards | `viewer`, `editor`
Integration Services | `viewer`, `editor`
Integration Webhooks | `viewer`, `editor`
Expand Down
8 changes: 4 additions & 4 deletions src/datadog_api_client/v2/api/ai_gateway_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -1619,7 +1619,7 @@ def create_ai_gateway_data_capture_override(
) -> AiGatewayCaptureOverrideResponse:
"""Create an AI Gateway data capture override.

Create a scoped override with a client-generated UUID and the current ``configuration_revision``. If the override can enable full capture for more traffic, set ``confirm_full_capture`` to ``true``. Returns HTTP 409 when ``configuration_revision`` is stale, the UUID already exists, or the organization has 100 overrides. Missing ``configuration_revision`` or required full-capture confirmation returns HTTP 400. Retrying an accepted create with the same UUID returns HTTP 409. To undo a create, read the current configuration revision and delete the override using its returned override revision.
Create a scoped override with a client-generated UUID and the current ``configuration_revision``. If the override can enable full capture for more traffic, set ``confirm_full_capture`` to ``true``. Returns HTTP 409 when ``configuration_revision`` is stale, the UUID already exists, or the organization has 100 overrides. Missing ``configuration_revision`` or required full-capture confirmation returns HTTP 400. Retrying an accepted create with the same UUID returns HTTP 409. To undo a create, read the current configuration revision and delete the override using its returned override revision. Requires ``ai_gateway_config_write``. Restriction policies are saved separately after the returned UUID and revision acknowledge creation. A lost response is an unknown outcome; absence from a filtered configuration response does not prove creation failed.

:type body: AiGatewayCaptureCreateRequest
:rtype: AiGatewayCaptureOverrideResponse
Expand Down Expand Up @@ -1746,7 +1746,7 @@ def delete_ai_gateway_data_capture_override(
) -> None:
"""Delete an AI Gateway data capture override.

Delete an override using its ``revision`` and the current ``configuration_revision``. If deleting the override can enable full capture for affected traffic, set ``confirm_full_capture`` to ``true``. Returns HTTP 409 when ``configuration_revision`` or the override ``revision`` is stale, including a concurrent change during deletion. Missing revisions or required full-capture confirmation returns HTTP 400.
Delete an override using its ``revision`` and the current ``configuration_revision``. If deleting the override can enable full capture for affected traffic, set ``confirm_full_capture`` to ``true``. Returns HTTP 409 when ``configuration_revision`` or the override ``revision`` is stale, including a concurrent change during deletion. Missing revisions or required full-capture confirmation returns HTTP 400. Requires ``ai_gateway_config_write`` and View and Edit access to this override. Hidden overrides return HTTP 404; visible overrides without Edit return HTTP 403. Authorization failures return HTTP 503. If permission cleanup fails after the deletion is committed, the response is HTTP 500 with code ``deletion_permission_cleanup_failed`` , ``meta.configuration_deleted=true`` , and ``meta.permissions_cleanup_failed=true``. Do not retry the deletion.

:param id: Data capture override ID.
:type id: UUID
Expand Down Expand Up @@ -1980,7 +1980,7 @@ def get_ai_gateway_data_capture_configuration(
) -> AiGatewayCaptureConfigurationResponse:
"""Get the AI Gateway data capture configuration.

Get the organization default mode, scoped capture overrides, and configuration revision.
Get the organization default mode, scoped capture overrides, and configuration revision. Requires ``ai_gateway_config_read``. Only overrides the caller can View are returned. Hidden overrides remain effective and contribute to ``configuration_revision``. An override missing from the response is not necessarily deleted.

:rtype: AiGatewayCaptureConfigurationResponse
"""
Expand Down Expand Up @@ -2531,7 +2531,7 @@ def update_ai_gateway_data_capture_override(
) -> AiGatewayCaptureOverrideResponse:
"""Replace an AI Gateway data capture override.

Replace an override using its ``revision`` and the current ``configuration_revision``. Changes to capture overrides don't affect routing rules. Returns HTTP 409 when ``configuration_revision`` or the override ``revision`` is stale, including a concurrent change during replacement. Missing revisions or required full-capture confirmation returns HTTP 400.
Replace an override using its ``revision`` and the current ``configuration_revision``. Changes to capture overrides don't affect routing rules. Returns HTTP 409 when ``configuration_revision`` or the override ``revision`` is stale, including a concurrent change during replacement. Missing revisions or required full-capture confirmation returns HTTP 400. Requires ``ai_gateway_config_write`` and View and Edit access to this override. Hidden overrides return HTTP 404; visible overrides without Edit return HTTP 403. Authorization failures return HTTP 503. The returned UUID and revision acknowledge the saved configuration even if the caller can no longer list it. Restriction policies are saved separately.

:param id: Data capture override ID.
:type id: UUID
Expand Down
Loading
Loading