diff --git a/hugo/content/en/api/v2/cloud-cost-management/examples.json b/hugo/content/en/api/v2/cloud-cost-management/examples.json index 17709d3be38..0b0867cdda1 100644 --- a/hugo/content/en/api/v2/cloud-cost-management/examples.json +++ b/hugo/content/en/api/v2/cloud-cost-management/examples.json @@ -3598,6 +3598,13 @@ "request": { "json_curl": { "data": { + "attributes": { + "sort": [ + { + "order": "DESC" + } + ] + }, "type": "recommendations_filter" } }, @@ -3605,20 +3612,20 @@ "data": { "attributes": { "filter": "@resource_table:aws_ec2_instance", - "scope": "string", + "scope": "ccm", "sort": [ { - "expression": "string", - "order": "string" + "expression": "@potential_daily_savings", + "order": "DESC" } ], - "view": "string" + "view": "active" }, - "id": "string", + "id": "@resource_table:aws_ec2_instance", "type": "recommendations_filter" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

JSON:API resource containing the cost recommendations filter. This legacy search contract\nuses the resource ID for the filter expression rather than as a persistent resource identifier.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes used to filter and sort cost recommendations.

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

Filter expression applied to the recommendations. When supplied, this attribute overrides\ndata.id, including when empty. When omitted, data.id is used. If the resulting filter\nis empty, it defaults to *. Scope, view, and pagination still apply.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

enum

\n

Recommendations scope. Defaults to ccm; use experiment for experimental recommendations\nor * for both. \nAllowed enum values: ccm,experiment,*

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

[object]

\n

Ordered list of sort clauses applied to the result set.

\n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

Field to sort by (for example, @potential_daily_savings).

\n
\n \n
\n
\n
\n
\n
\n

order

\n
\n

string

\n

Sort direction, either ASC or DESC.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

view

\n
\n

string

\n

Status view to return: all, active (not dismissed), dismissed, open, in-progress,\nor completed. Defaults to all, which returns recommendations in every status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Filter expression applied to the recommendations when attributes.filter is omitted.\nWhen supplied, attributes.filter overrides this value, including when empty. If the\nresulting filter is empty, it defaults to *. Scope, view, and pagination still apply.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Legacy JSON:API resource type required by the cost recommendations search decoder. \nAllowed enum values: recommendations_filter

default: recommendations_filter

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

JSON:API resource containing the cost recommendations filter. This legacy search contract\nuses the resource ID for the filter expression rather than as a persistent resource identifier.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes used to filter and sort cost recommendations.

\n
\n
\n
\n
\n
\n

filter

\n
\n

string

\n

Filter expression applied to the recommendations. When supplied, this attribute overrides\ndata.id, including when empty. When omitted, data.id is used. If the resulting filter\nis empty, it defaults to *. Scope, view, and pagination still apply.

\n
\n \n
\n
\n
\n
\n
\n

scope

\n
\n

enum

\n

Recommendations scope. Defaults to ccm; use experiment for experimental recommendations\nor * for both. An empty value is treated as ccm. \nAllowed enum values: ccm,experiment,*,

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

[object]

\n

Ordered list of sort clauses applied to the result set.

\n
\n
\n
\n
\n
\n

expression

\n
\n

string

\n

Field to sort by (for example, @potential_daily_savings).

\n
\n \n
\n
\n
\n
\n
\n

order [required]

\n
\n

string

\n

Sort direction, either ASC or DESC (case-insensitive).

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

view

\n
\n

string

\n

Status view to return: all, active (not dismissed), dismissed, open, in-progress,\nor completed. Defaults to all, which returns recommendations in every status.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Filter expression applied to the recommendations when attributes.filter is omitted.\nWhen supplied, attributes.filter overrides this value, including when empty. If the\nresulting filter is empty, it defaults to *. Scope, view, and pagination still apply.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Legacy JSON:API resource type required by the cost recommendations search decoder. \nAllowed enum values: recommendations_filter

default: recommendations_filter

\n
\n \n
\n
\n
\n
" } }, "ListCostTagDescriptions": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index 7a7bd2b981a..adca8695d4f 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -106393,6 +106393,7 @@ components: Filter expression applied to the recommendations when `attributes.filter` is omitted. When supplied, `attributes.filter` overrides this value, including when empty. If the resulting filter is empty, it defaults to `*`. Scope, view, and pagination still apply. + example: "@resource_table:aws_ec2_instance" type: string type: $ref: "#/components/schemas/RecommendationsFilterRequestDataType" @@ -106420,6 +106421,7 @@ components: description: |- Status view to return: `all`, `active` (not dismissed), `dismissed`, `open`, `in-progress`, or `completed`. Defaults to `all`, which returns recommendations in every status. + example: active type: string type: object RecommendationsFilterRequestDataType: @@ -106434,25 +106436,32 @@ components: RecommendationsFilterRequestScope: description: |- Recommendations scope. Defaults to `ccm`; use `experiment` for experimental recommendations - or `*` for both. + or `*` for both. An empty value is treated as `ccm`. enum: - ccm - experiment - "*" + - "" + example: ccm type: string x-enum-varnames: - CCM - EXPERIMENT - ALL + - EMPTY RecommendationsFilterRequestSortItems: description: A single sort clause applied to the cost recommendations result set. properties: expression: description: Field to sort by (for example, `@potential_daily_savings`). + example: "@potential_daily_savings" type: string order: - description: Sort direction, either `ASC` or `DESC`. + description: Sort direction, either `ASC` or `DESC` (case-insensitive). + example: DESC type: string + required: + - order type: object RecommendationsPageMeta: description: Top-level JSON:API meta object for paginated cost recommendation responses. diff --git a/hugo/data/changelog/cloud-cost-management.yml b/hugo/data/changelog/cloud-cost-management.yml index 7f308b6d781..97f7a9d10d1 100644 --- a/hugo/data/changelog/cloud-cost-management.yml +++ b/hugo/data/changelog/cloud-cost-management.yml @@ -17,3 +17,10 @@ entries: operations: - SearchCostRecommendations title: Document errors and page size limits for cost recommendations search + - change_type: modified + date: '2026-10-30' + link: https://github.com/DataDog/documentation/pull/41230 + operations: + - SearchCostRecommendations + title: Fix request examples and document request validation for cost + recommendations search