Skip to content

Commit 70b5e1a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add OpenAPI definitions for CCM status endpoints (#4032)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 2948a8f commit 70b5e1a

15 files changed

Lines changed: 1308 additions & 0 deletions

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6353,6 +6353,62 @@ components:
63536353
type: string
63546354
x-enum-varnames:
63556355
- ARBITRARY_RULE
6356+
ArbitraryRuleStatusResponseArray:
6357+
description: Processing statuses for all custom allocation rules in the specified organization.
6358+
example:
6359+
data:
6360+
- attributes:
6361+
processing_status: processing
6362+
id: "123"
6363+
type: arbitrary_rule_status
6364+
- attributes:
6365+
processing_status: done
6366+
id: "456"
6367+
type: arbitrary_rule_status
6368+
properties:
6369+
data:
6370+
description: Processing status for a custom allocation rule.
6371+
items:
6372+
$ref: "#/components/schemas/ArbitraryRuleStatusResponseData"
6373+
type: array
6374+
required:
6375+
- data
6376+
type: object
6377+
ArbitraryRuleStatusResponseData:
6378+
description: Processing status for a custom allocation rule.
6379+
properties:
6380+
attributes:
6381+
$ref: "#/components/schemas/ArbitraryRuleStatusResponseDataAttributes"
6382+
id:
6383+
description: The unique identifier of the custom allocation rule.
6384+
example: "123"
6385+
type: string
6386+
type:
6387+
$ref: "#/components/schemas/ArbitraryRuleStatusResponseDataType"
6388+
required:
6389+
- id
6390+
- type
6391+
- attributes
6392+
type: object
6393+
ArbitraryRuleStatusResponseDataAttributes:
6394+
description: Processing status for a custom allocation rule.
6395+
properties:
6396+
processing_status:
6397+
description: The processing status of the custom allocation rule.
6398+
example: processing
6399+
type: string
6400+
required:
6401+
- processing_status
6402+
type: object
6403+
ArbitraryRuleStatusResponseDataType:
6404+
default: arbitrary_rule_status
6405+
description: Custom allocation rule status resource type.
6406+
enum:
6407+
- arbitrary_rule_status
6408+
example: arbitrary_rule_status
6409+
type: string
6410+
x-enum-varnames:
6411+
- ARBITRARY_RULE_STATUS
63566412
Argument:
63576413
description: A named argument for a custom static analysis rule.
63586414
properties:
@@ -60398,6 +60454,62 @@ components:
6039860454
type: string
6039960455
x-enum-varnames:
6040060456
- RULESET
60457+
RulesetStatusRespArray:
60458+
description: Processing statuses for all tag pipeline rulesets in the specified organization.
60459+
example:
60460+
data:
60461+
- attributes:
60462+
processing_status: processing
60463+
id: 55ef2385-9ae1-4410-90c4-5ac1b60fec10
60464+
type: ruleset_status
60465+
- attributes:
60466+
processing_status: done
60467+
id: a7b8c9d0-1234-5678-9abc-def012345678
60468+
type: ruleset_status
60469+
properties:
60470+
data:
60471+
description: Processing status for a tag pipeline ruleset.
60472+
items:
60473+
$ref: "#/components/schemas/RulesetStatusRespData"
60474+
type: array
60475+
required:
60476+
- data
60477+
type: object
60478+
RulesetStatusRespData:
60479+
description: Processing status for a tag pipeline ruleset.
60480+
properties:
60481+
attributes:
60482+
$ref: "#/components/schemas/RulesetStatusRespDataAttributes"
60483+
id:
60484+
description: The unique identifier of the ruleset.
60485+
example: 55ef2385-9ae1-4410-90c4-5ac1b60fec10
60486+
type: string
60487+
type:
60488+
$ref: "#/components/schemas/RulesetStatusRespDataType"
60489+
required:
60490+
- id
60491+
- type
60492+
- attributes
60493+
type: object
60494+
RulesetStatusRespDataAttributes:
60495+
description: Processing status for a tag pipeline ruleset.
60496+
properties:
60497+
processing_status:
60498+
description: The processing status of the ruleset.
60499+
example: processing
60500+
type: string
60501+
required:
60502+
- processing_status
60503+
type: object
60504+
RulesetStatusRespDataType:
60505+
default: ruleset_status
60506+
description: Ruleset status resource type.
60507+
enum:
60508+
- ruleset_status
60509+
example: ruleset_status
60510+
type: string
60511+
x-enum-varnames:
60512+
- RULESET_STATUS
6040160513
RumCrossProductSampling:
6040260514
description: The configuration for cross-product retention filters.
6040360515
properties:
@@ -94972,6 +95084,39 @@ paths:
9497295084
summary: Reorder custom allocation rules
9497395085
tags:
9497495086
- Cloud Cost Management
95087+
/api/v2/cost/arbitrary_rule/status:
95088+
get:
95089+
description: List the processing status of all custom allocation rules. Returns only the ID and processing status for each rule.
95090+
operationId: ListCustomAllocationRulesStatus
95091+
responses:
95092+
"200":
95093+
content:
95094+
application/json:
95095+
examples:
95096+
default:
95097+
value:
95098+
data:
95099+
- attributes:
95100+
processing_status: processing
95101+
id: "123"
95102+
type: arbitrary_rule_status
95103+
- attributes:
95104+
processing_status: done
95105+
id: "456"
95106+
type: arbitrary_rule_status
95107+
schema:
95108+
$ref: "#/components/schemas/ArbitraryRuleStatusResponseArray"
95109+
description: OK
95110+
"429":
95111+
$ref: "#/components/responses/TooManyRequestsResponse"
95112+
security:
95113+
- apiKeyAuth: []
95114+
appKeyAuth: []
95115+
- AuthZ:
95116+
- cloud_cost_management_read
95117+
summary: List custom allocation rule statuses
95118+
tags:
95119+
- Cloud Cost Management
9497595120
/api/v2/cost/arbitrary_rule/{rule_id}:
9497695121
delete:
9497795122
description: Delete a custom allocation rule - Delete an existing custom allocation rule by its ID
@@ -141041,6 +141186,39 @@ paths:
141041141186
summary: Reorder tag pipeline rulesets
141042141187
tags:
141043141188
- Cloud Cost Management
141189+
/api/v2/tags/enrichment/status:
141190+
get:
141191+
description: List the processing status of all tag pipeline rulesets. Returns only the ID and processing status for each ruleset.
141192+
operationId: ListTagPipelinesRulesetsStatus
141193+
responses:
141194+
"200":
141195+
content:
141196+
application/json:
141197+
examples:
141198+
default:
141199+
value:
141200+
data:
141201+
- attributes:
141202+
processing_status: processing
141203+
id: 55ef2385-9ae1-4410-90c4-5ac1b60fec10
141204+
type: ruleset_status
141205+
- attributes:
141206+
processing_status: done
141207+
id: a7b8c9d0-1234-5678-9abc-def012345678
141208+
type: ruleset_status
141209+
schema:
141210+
$ref: "#/components/schemas/RulesetStatusRespArray"
141211+
description: OK
141212+
"429":
141213+
$ref: "#/components/responses/TooManyRequestsResponse"
141214+
security:
141215+
- apiKeyAuth: []
141216+
appKeyAuth: []
141217+
- AuthZ:
141218+
- cloud_cost_management_read
141219+
summary: List tag pipeline ruleset statuses
141220+
tags:
141221+
- Cloud Cost Management
141044141222
/api/v2/tags/enrichment/validate-query:
141045141223
post:
141046141224
description: Validate a tag pipeline query - Validate the syntax and structure of a tag pipeline query

‎api/datadogV2/api_cloud_cost_management.go‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1912,6 +1912,83 @@ func (a *CloudCostManagementApi) ListCustomAllocationRules(ctx _context.Context)
19121912
return localVarReturnValue, localVarHTTPResponse, nil
19131913
}
19141914

1915+
// ListCustomAllocationRulesStatus List custom allocation rule statuses.
1916+
// List the processing status of all custom allocation rules. Returns only the ID and processing status for each rule.
1917+
func (a *CloudCostManagementApi) ListCustomAllocationRulesStatus(ctx _context.Context) (ArbitraryRuleStatusResponseArray, *_nethttp.Response, error) {
1918+
var (
1919+
localVarHTTPMethod = _nethttp.MethodGet
1920+
localVarPostBody interface{}
1921+
localVarReturnValue ArbitraryRuleStatusResponseArray
1922+
)
1923+
1924+
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.CloudCostManagementApi.ListCustomAllocationRulesStatus")
1925+
if err != nil {
1926+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
1927+
}
1928+
1929+
localVarPath := localBasePath + "/api/v2/cost/arbitrary_rule/status"
1930+
1931+
localVarHeaderParams := make(map[string]string)
1932+
localVarQueryParams := _neturl.Values{}
1933+
localVarFormParams := _neturl.Values{}
1934+
localVarHeaderParams["Accept"] = "application/json"
1935+
1936+
if a.Client.Cfg.DelegatedTokenConfig != nil {
1937+
err = datadog.UseDelegatedTokenAuth(ctx, &localVarHeaderParams, a.Client.Cfg.DelegatedTokenConfig)
1938+
if err != nil {
1939+
return localVarReturnValue, nil, err
1940+
}
1941+
} else {
1942+
datadog.SetAuthKeys(
1943+
ctx,
1944+
&localVarHeaderParams,
1945+
[2]string{"apiKeyAuth", "DD-API-KEY"},
1946+
[2]string{"appKeyAuth", "DD-APPLICATION-KEY"},
1947+
)
1948+
}
1949+
req, err := a.Client.PrepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, nil)
1950+
if err != nil {
1951+
return localVarReturnValue, nil, err
1952+
}
1953+
1954+
localVarHTTPResponse, err := a.Client.CallAPI(req)
1955+
if err != nil || localVarHTTPResponse == nil {
1956+
return localVarReturnValue, localVarHTTPResponse, err
1957+
}
1958+
1959+
localVarBody, err := datadog.ReadBody(localVarHTTPResponse)
1960+
if err != nil {
1961+
return localVarReturnValue, localVarHTTPResponse, err
1962+
}
1963+
1964+
if localVarHTTPResponse.StatusCode >= 300 {
1965+
newErr := datadog.GenericOpenAPIError{
1966+
ErrorBody: localVarBody,
1967+
ErrorMessage: localVarHTTPResponse.Status,
1968+
}
1969+
if localVarHTTPResponse.StatusCode == 429 {
1970+
var v APIErrorResponse
1971+
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
1972+
if err != nil {
1973+
return localVarReturnValue, localVarHTTPResponse, newErr
1974+
}
1975+
newErr.ErrorModel = v
1976+
}
1977+
return localVarReturnValue, localVarHTTPResponse, newErr
1978+
}
1979+
1980+
err = a.Client.Decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
1981+
if err != nil {
1982+
newErr := datadog.GenericOpenAPIError{
1983+
ErrorBody: localVarBody,
1984+
ErrorMessage: err.Error(),
1985+
}
1986+
return localVarReturnValue, localVarHTTPResponse, newErr
1987+
}
1988+
1989+
return localVarReturnValue, localVarHTTPResponse, nil
1990+
}
1991+
19151992
// ListCustomCostsFilesOptionalParameters holds optional parameters for ListCustomCostsFiles.
19161993
type ListCustomCostsFilesOptionalParameters struct {
19171994
PageNumber *int64
@@ -2152,6 +2229,83 @@ func (a *CloudCostManagementApi) ListTagPipelinesRulesets(ctx _context.Context)
21522229
return localVarReturnValue, localVarHTTPResponse, nil
21532230
}
21542231

2232+
// ListTagPipelinesRulesetsStatus List tag pipeline ruleset statuses.
2233+
// List the processing status of all tag pipeline rulesets. Returns only the ID and processing status for each ruleset.
2234+
func (a *CloudCostManagementApi) ListTagPipelinesRulesetsStatus(ctx _context.Context) (RulesetStatusRespArray, *_nethttp.Response, error) {
2235+
var (
2236+
localVarHTTPMethod = _nethttp.MethodGet
2237+
localVarPostBody interface{}
2238+
localVarReturnValue RulesetStatusRespArray
2239+
)
2240+
2241+
localBasePath, err := a.Client.Cfg.ServerURLWithContext(ctx, "v2.CloudCostManagementApi.ListTagPipelinesRulesetsStatus")
2242+
if err != nil {
2243+
return localVarReturnValue, nil, datadog.GenericOpenAPIError{ErrorMessage: err.Error()}
2244+
}
2245+
2246+
localVarPath := localBasePath + "/api/v2/tags/enrichment/status"
2247+
2248+
localVarHeaderParams := make(map[string]string)
2249+
localVarQueryParams := _neturl.Values{}
2250+
localVarFormParams := _neturl.Values{}
2251+
localVarHeaderParams["Accept"] = "application/json"
2252+
2253+
if a.Client.Cfg.DelegatedTokenConfig != nil {
2254+
err = datadog.UseDelegatedTokenAuth(ctx, &localVarHeaderParams, a.Client.Cfg.DelegatedTokenConfig)
2255+
if err != nil {
2256+
return localVarReturnValue, nil, err
2257+
}
2258+
} else {
2259+
datadog.SetAuthKeys(
2260+
ctx,
2261+
&localVarHeaderParams,
2262+
[2]string{"apiKeyAuth", "DD-API-KEY"},
2263+
[2]string{"appKeyAuth", "DD-APPLICATION-KEY"},
2264+
)
2265+
}
2266+
req, err := a.Client.PrepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, nil)
2267+
if err != nil {
2268+
return localVarReturnValue, nil, err
2269+
}
2270+
2271+
localVarHTTPResponse, err := a.Client.CallAPI(req)
2272+
if err != nil || localVarHTTPResponse == nil {
2273+
return localVarReturnValue, localVarHTTPResponse, err
2274+
}
2275+
2276+
localVarBody, err := datadog.ReadBody(localVarHTTPResponse)
2277+
if err != nil {
2278+
return localVarReturnValue, localVarHTTPResponse, err
2279+
}
2280+
2281+
if localVarHTTPResponse.StatusCode >= 300 {
2282+
newErr := datadog.GenericOpenAPIError{
2283+
ErrorBody: localVarBody,
2284+
ErrorMessage: localVarHTTPResponse.Status,
2285+
}
2286+
if localVarHTTPResponse.StatusCode == 429 {
2287+
var v APIErrorResponse
2288+
err = a.Client.Decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
2289+
if err != nil {
2290+
return localVarReturnValue, localVarHTTPResponse, newErr
2291+
}
2292+
newErr.ErrorModel = v
2293+
}
2294+
return localVarReturnValue, localVarHTTPResponse, newErr
2295+
}
2296+
2297+
err = a.Client.Decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
2298+
if err != nil {
2299+
newErr := datadog.GenericOpenAPIError{
2300+
ErrorBody: localVarBody,
2301+
ErrorMessage: err.Error(),
2302+
}
2303+
return localVarReturnValue, localVarHTTPResponse, newErr
2304+
}
2305+
2306+
return localVarReturnValue, localVarHTTPResponse, nil
2307+
}
2308+
21552309
// ReorderCustomAllocationRules Reorder custom allocation rules.
21562310
// Reorder custom allocation rules - Change the execution order of custom allocation rules.
21572311
//

‎api/datadogV2/doc.go‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,10 @@
200200
// - [CloudCostManagementApi.ListCostGCPUsageCostConfigs]
201201
// - [CloudCostManagementApi.ListCostOCIConfigs]
202202
// - [CloudCostManagementApi.ListCustomAllocationRules]
203+
// - [CloudCostManagementApi.ListCustomAllocationRulesStatus]
203204
// - [CloudCostManagementApi.ListCustomCostsFiles]
204205
// - [CloudCostManagementApi.ListTagPipelinesRulesets]
206+
// - [CloudCostManagementApi.ListTagPipelinesRulesetsStatus]
205207
// - [CloudCostManagementApi.ReorderCustomAllocationRules]
206208
// - [CloudCostManagementApi.ReorderTagPipelinesRulesets]
207209
// - [CloudCostManagementApi.UpdateCostAWSCURConfig]

0 commit comments

Comments
 (0)