Skip to content

Add OpenAPI definitions for path-param tag_description endpoints #3552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI definitions for path-param tag_description endpoints #3552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
332 changes: 332 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18173,6 +18173,25 @@ components:
- tag_key
- updated_at
type: object
CostTagDescriptionResponse:
description: Single Cloud Cost Management tag key description returned by the get-by-key endpoint.
example:
data:
attributes:
cloud: aws
created_at: "2026-01-01T12:00:00Z"
description: AWS account that owns this cost.
source: human
tag_key: account_id
updated_at: "2026-01-01T12:00:00Z"
id: account_id
type: cost_tag_description
properties:
data:
$ref: "#/components/schemas/CostTagDescription"
required:
- data
type: object
CostTagDescriptionSource:
description: Origin of the description. `human` indicates the description was written by a user, `ai_generated` was produced by AI, and `datadog` is a default supplied by Datadog.
enum:
Expand All @@ -18194,6 +18213,50 @@ components:
type: string
x-enum-varnames:
- COST_TAG_DESCRIPTION
CostTagDescriptionUpsertRequest:
description: Request body for creating or updating a Cloud Cost Management tag key description.
example:
data:
attributes:
cloud: aws
description: AWS account that owns this cost.
id: account_id
type: cost_tag_description
properties:
data:
$ref: "#/components/schemas/CostTagDescriptionUpsertRequestData"
required:
- data
type: object
CostTagDescriptionUpsertRequestData:
description: Resource envelope carrying the tag key description being upserted. The `id` is informational; the authoritative tag key is taken from the URL path.
properties:
attributes:
$ref: "#/components/schemas/CostTagDescriptionUpsertRequestDataAttributes"
id:
description: Identifier of the tag key the description applies to. Matches the `tag_key` path parameter.
example: account_id
type: string
type:
$ref: "#/components/schemas/CostTagDescriptionType"
required:
- attributes
- type
type: object
CostTagDescriptionUpsertRequestDataAttributes:
description: Mutable attributes set when creating or updating a Cloud Cost Management tag key description.
properties:
cloud:
description: Cloud provider this description applies to (for example, `aws`). Omit to set the cross-cloud default for the tag key.
example: aws
type: string
description:
description: The human-readable description for the tag key.
example: AWS account that owns this cost.
type: string
required:
- description
type: object
CostTagDescriptionsResponse:
description: List of Cloud Cost Management tag key descriptions for the organization, optionally filtered to a single cloud provider.
example:
Expand Down Expand Up @@ -34119,6 +34182,55 @@ components:
required:
- type
type: object
GenerateCostTagDescriptionResponse:
description: Response wrapping an AI-generated Cloud Cost Management tag key description.
example:
data:
attributes:
description: AWS account that owns this cost.
id: account_id
type: cost_generated_tag_description
properties:
data:
$ref: "#/components/schemas/GeneratedCostTagDescription"
required:
- data
type: object
GeneratedCostTagDescription:
description: AI-generated Cloud Cost Management tag key description returned by the generate endpoint. The result is returned to the client but is not persisted by this endpoint.
properties:
attributes:
$ref: "#/components/schemas/GeneratedCostTagDescriptionAttributes"
id:
description: The tag key the AI description was generated for.
example: account_id
type: string
type:
$ref: "#/components/schemas/GeneratedCostTagDescriptionType"
required:
- attributes
- id
- type
type: object
GeneratedCostTagDescriptionAttributes:
description: Attributes of an AI-generated Cloud Cost Management tag key description.
properties:
description:
description: The AI-generated description for the tag key.
example: AWS account that owns this cost.
type: string
required:
- description
type: object
GeneratedCostTagDescriptionType:
default: cost_generated_tag_description
description: Type of the AI-generated Cloud Cost Management tag description resource.
enum:
- cost_generated_tag_description
example: cost_generated_tag_description
type: string
x-enum-varnames:
- COST_GENERATED_TAG_DESCRIPTION
GetActionConnectionResponse:
description: The response for found connection
properties:
Expand Down Expand Up @@ -108672,6 +108784,226 @@ paths:
operator: OR
permissions:
- cloud_cost_management_read
/api/v2/cost/tag_descriptions/{tag_key}:
delete:
description: Delete a Cloud Cost Management tag key description. When `cloud` is omitted, deletes every description for the tag key, falling back to Datadog's global default when available. When `cloud` is provided, deletes only the description scoped to that cloud provider.
operationId: DeleteCostTagDescriptionByKey
parameters:
- description: The tag key whose description is being deleted.
in: path
name: tag_key
required: true
schema:
type: string
- description: Cloud provider to scope the deletion to (for example, `aws`). Omit to delete every description for the tag key.
in: query
name: cloud
required: false
schema:
type: string
responses:
"204":
description: No Content
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Bad Request
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cloud_cost_management_write
summary: Delete a Cloud Cost Management tag description
tags:
- Cloud Cost Management
"x-permission":
operator: OR
permissions:
- cloud_cost_management_write
get:
description: Get the Cloud Cost Management description for a single tag key. Use `filter[cloud]` to scope the lookup to a specific cloud provider; when omitted, the response resolves the description in fallback order (cloud-specific organization override, then cloudless organization default, then Datadog's global default).
operationId: GetCostTagDescriptionByKey
parameters:
- description: The tag key whose description is being fetched.
in: path
name: tag_key
required: true
schema:
type: string
- description: Cloud provider to scope the lookup to (for example, `aws`). Omit to use the resolved fallback.
in: query
name: filter[cloud]
required: false
schema:
type: string
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
attributes:
cloud: aws
created_at: "2026-01-01T12:00:00Z"
description: AWS account that owns this cost.
source: human
tag_key: account_id
updated_at: "2026-01-01T12:00:00Z"
id: account_id
type: cost_tag_description
schema:
$ref: "#/components/schemas/CostTagDescriptionResponse"
description: OK
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Bad Request
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Forbidden
"404":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cloud_cost_management_read
summary: Get a Cloud Cost Management tag description
tags:
- Cloud Cost Management
"x-permission":
operator: OR
permissions:
- cloud_cost_management_read
put:
description: Create or update a Cloud Cost Management tag key description. The new description and optional cloud scoping are supplied in the request body. Omit `cloud` to set a cross-cloud default for the tag key.
operationId: UpsertCostTagDescriptionByKey
parameters:
- description: The tag key whose description is being upserted.
in: path
name: tag_key
required: true
schema:
type: string
requestBody:
content:
application/json:
examples:
default:
value:
data:
attributes:
cloud: aws
description: AWS account that owns this cost.
id: account_id
type: cost_tag_description
schema:
$ref: "#/components/schemas/CostTagDescriptionUpsertRequest"
required: true
responses:
"204":
description: No Content
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Bad Request
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cloud_cost_management_write
summary: Upsert a Cloud Cost Management tag description
tags:
- Cloud Cost Management
"x-permission":
operator: OR
permissions:
- cloud_cost_management_write
/api/v2/cost/tag_descriptions/{tag_key}/generate:
get:
description: Use AI to draft a Cloud Cost Management tag key description based on associated cost data. The generated description is returned in the response and is not persisted by this endpoint; follow up with `UpsertCostTagDescriptionByKey` to save it.
operationId: GenerateCostTagDescriptionByKey
parameters:
- description: The tag key to generate an AI description for.
in: path
name: tag_key
required: true
schema:
type: string
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
attributes:
description: AWS account that owns this cost.
id: account_id
type: cost_generated_tag_description
schema:
$ref: "#/components/schemas/GenerateCostTagDescriptionResponse"
description: OK
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Bad Request
"403":
content:
application/json:
schema:
$ref: "#/components/schemas/APIErrorResponse"
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- cloud_cost_management_read
summary: Generate a Cloud Cost Management tag description
tags:
- Cloud Cost Management
"x-permission":
operator: OR
permissions:
- cloud_cost_management_read
/api/v2/cost/tag_keys:
get:
description: List Cloud Cost Management tag keys.
Expand Down
Loading
Loading