Skip to content

Commit afb47ed

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 564d4d6 of spec repo
1 parent 7983bca commit afb47ed

14 files changed

Lines changed: 2420 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 267 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43582,6 +43582,39 @@ components:
4358243582
example: "/api/v2/scorecard/rules?page%5Blimit%5D=2&page%5Boffset%5D=2&page%5Bsize%5D=2"
4358343583
type: string
4358443584
type: object
43585+
ListScorecardScoresMeta:
43586+
description: Pagination metadata for scores.
43587+
properties:
43588+
count:
43589+
description: The number of results returned in this page.
43590+
format: int64
43591+
type: integer
43592+
limit:
43593+
description: The page limit.
43594+
format: int64
43595+
type: integer
43596+
offset:
43597+
description: The page offset.
43598+
format: int64
43599+
type: integer
43600+
total:
43601+
description: The total number of results.
43602+
format: int64
43603+
type: integer
43604+
type: object
43605+
ListScorecardScoresResponse:
43606+
description: A list of scorecard scores for a given aggregation type.
43607+
properties:
43608+
data:
43609+
description: Array of score objects.
43610+
items:
43611+
$ref: "#/components/schemas/ScorecardScoreData"
43612+
type: array
43613+
links:
43614+
$ref: "#/components/schemas/ListRulesResponseLinks"
43615+
meta:
43616+
$ref: "#/components/schemas/ListScorecardScoresMeta"
43617+
type: object
4358543618
ListScorecardsResponse:
4358643619
description: Response containing a list of scorecards.
4358743620
properties:
@@ -64897,6 +64930,119 @@ components:
6489764930
type: string
6489864931
x-enum-varnames:
6489964932
- SCORECARD
64933+
ScorecardScoreAttributes:
64934+
description: Attributes of a scorecard score.
64935+
properties:
64936+
aggregation:
64937+
$ref: "#/components/schemas/ScorecardScoresAggregation"
64938+
denominator:
64939+
description: The denominator used to compute the score ratio.
64940+
format: int64
64941+
type: integer
64942+
level:
64943+
description: The maturity level of the associated rule.
64944+
format: int64
64945+
type: integer
64946+
numerator:
64947+
description: The numerator used to compute the score ratio.
64948+
format: int64
64949+
type: integer
64950+
score:
64951+
description: The computed score ratio (numerator/denominator), from 0 to 1.
64952+
format: double
64953+
type: number
64954+
total_entities:
64955+
description: The total number of entities evaluated.
64956+
format: int64
64957+
type: integer
64958+
total_fail:
64959+
description: The number of rules that failed.
64960+
format: int64
64961+
type: integer
64962+
total_no_data:
64963+
description: The number of rules with no data.
64964+
format: int64
64965+
type: integer
64966+
total_pass:
64967+
description: The number of rules that passed.
64968+
format: int64
64969+
type: integer
64970+
total_skip:
64971+
description: The number of rules that were skipped.
64972+
format: int64
64973+
type: integer
64974+
type: object
64975+
ScorecardScoreData:
64976+
description: A scorecard score object for a single entity, rule, scorecard, service, or team.
64977+
properties:
64978+
attributes:
64979+
$ref: "#/components/schemas/ScorecardScoreAttributes"
64980+
id:
64981+
description: The ID of the entity or resource being scored.
64982+
example: ""
64983+
type: string
64984+
relationships:
64985+
$ref: "#/components/schemas/ScorecardScoreRelationships"
64986+
type:
64987+
$ref: "#/components/schemas/ScorecardScoreDataType"
64988+
required:
64989+
- id
64990+
- type
64991+
type: object
64992+
ScorecardScoreDataType:
64993+
default: score
64994+
description: The JSON:API resource type.
64995+
enum: [score]
64996+
example: score
64997+
type: string
64998+
x-enum-varnames:
64999+
- SCORE
65000+
ScorecardScoreRelationshipData:
65001+
description: A relationship data object for a score.
65002+
properties:
65003+
id:
65004+
description: The ID of the related resource.
65005+
example: ""
65006+
type: string
65007+
type:
65008+
description: The type of the related resource.
65009+
example: ""
65010+
type: string
65011+
required:
65012+
- id
65013+
- type
65014+
type: object
65015+
ScorecardScoreRelationshipItem:
65016+
description: A relationship item for a score.
65017+
properties:
65018+
data:
65019+
$ref: "#/components/schemas/ScorecardScoreRelationshipData"
65020+
type: object
65021+
ScorecardScoreRelationships:
65022+
description: Relationships for a scorecard score, depending on the aggregation type.
65023+
properties:
65024+
entity:
65025+
$ref: "#/components/schemas/ScorecardScoreRelationshipItem"
65026+
rule:
65027+
$ref: "#/components/schemas/ScorecardScoreRelationshipItem"
65028+
scorecard:
65029+
$ref: "#/components/schemas/ScorecardScoreRelationshipItem"
65030+
service:
65031+
$ref: "#/components/schemas/ScorecardScoreRelationshipItem"
65032+
team:
65033+
$ref: "#/components/schemas/ScorecardScoreRelationshipItem"
65034+
type: object
65035+
ScorecardScoresAggregation:
65036+
description: Dimension to group scores by.
65037+
enum: [by-entity, by-rule, by-scorecard, by-team, by-kind]
65038+
example: by-entity
65039+
type: string
65040+
x-enum-varnames:
65041+
- BY_ENTITY
65042+
- BY_RULE
65043+
- BY_SCORECARD
65044+
- BY_TEAM
65045+
- BY_KIND
6490065046
ScorecardType:
6490165047
default: scorecard
6490265048
description: The JSON:API type for scorecard.
@@ -132294,6 +132440,127 @@ paths:
132294132440
summary: List all scorecards
132295132441
tags:
132296132442
- Scorecards
132443+
/api/v2/scorecard/scores/{aggregation}:
132444+
get:
132445+
description: Returns a list of scorecard scores for each aggregation type, with score breakdowns.
132446+
operationId: ListScorecardScores
132447+
parameters:
132448+
- description: The type of scores being requested.
132449+
in: path
132450+
name: aggregation
132451+
required: true
132452+
schema:
132453+
$ref: "#/components/schemas/ScorecardScoresAggregation"
132454+
- description: Filter scores by an entity query string.
132455+
in: query
132456+
name: filter[entity][query]
132457+
required: false
132458+
schema:
132459+
type: string
132460+
- description: Filter scores by rule ID(s), comma-separated.
132461+
in: query
132462+
name: filter[rule][id]
132463+
required: false
132464+
schema:
132465+
type: string
132466+
- description: Filter scores by rule name.
132467+
in: query
132468+
name: filter[rule][name]
132469+
required: false
132470+
schema:
132471+
type: string
132472+
- description: Filter scores by rule level(s), comma-separated.
132473+
in: query
132474+
name: filter[rule][level]
132475+
required: false
132476+
schema:
132477+
type: string
132478+
- description: Filter scores by scorecard ID(s), comma-separated.
132479+
in: query
132480+
name: filter[rule][scorecard_id]
132481+
required: false
132482+
schema:
132483+
type: string
132484+
- description: Filter scores to show only custom rules.
132485+
in: query
132486+
name: filter[rule][is_custom]
132487+
required: false
132488+
schema:
132489+
type: boolean
132490+
- description: Filter scores to show only enabled rules.
132491+
in: query
132492+
name: filter[rule][is_enabled]
132493+
required: false
132494+
schema:
132495+
type: boolean
132496+
- description: "Sort scores by field. Use a hyphen prefix for descending order. Options: score, numerator, denominator, total_pass, total_fail, total_skip, total_no_data."
132497+
in: query
132498+
name: sort
132499+
required: false
132500+
schema:
132501+
type: string
132502+
- description: Offset for pagination.
132503+
in: query
132504+
name: page[offset]
132505+
required: false
132506+
schema:
132507+
default: 0
132508+
type: integer
132509+
- description: Number of scores to return. Max is 1000.
132510+
in: query
132511+
name: page[limit]
132512+
required: false
132513+
schema:
132514+
default: 100
132515+
type: integer
132516+
responses:
132517+
"200":
132518+
content:
132519+
application/json:
132520+
examples:
132521+
default:
132522+
value:
132523+
data:
132524+
- attributes:
132525+
aggregation: by-entity
132526+
denominator: 4
132527+
numerator: 3
132528+
score: 0.75
132529+
total_fail: 1
132530+
total_no_data: 0
132531+
total_pass: 3
132532+
total_skip: 0
132533+
id: service:my-service
132534+
relationships:
132535+
entity:
132536+
data:
132537+
id: service:my-service
132538+
type: entity
132539+
type: score
132540+
links:
132541+
next: /api/v2/scorecard/scores/by-entity?page[offset]=100&page[limit]=100
132542+
meta:
132543+
count: 1
132544+
limit: 100
132545+
offset: 0
132546+
total: 42
132547+
schema:
132548+
$ref: "#/components/schemas/ListScorecardScoresResponse"
132549+
description: OK
132550+
"400":
132551+
$ref: "#/components/responses/BadRequestResponse"
132552+
"403":
132553+
$ref: "#/components/responses/ForbiddenResponse"
132554+
"429":
132555+
$ref: "#/components/responses/TooManyRequestsResponse"
132556+
security:
132557+
- apiKeyAuth: []
132558+
appKeyAuth: []
132559+
- AuthZ:
132560+
- apm_service_catalog_read
132561+
summary: List all scores
132562+
tags:
132563+
- Scorecards
132297132564
/api/v2/seats/users:
132298132565
delete:
132299132566
description: |-
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// List all scores returns "OK" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.ScorecardsApi;
6+
import com.datadog.api.client.v2.model.ListScorecardScoresResponse;
7+
import com.datadog.api.client.v2.model.ScorecardScoresAggregation;
8+
9+
public class Example {
10+
public static void main(String[] args) {
11+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
12+
ScorecardsApi apiInstance = new ScorecardsApi(defaultClient);
13+
14+
try {
15+
ListScorecardScoresResponse result =
16+
apiInstance.listScorecardScores(ScorecardScoresAggregation.BY_ENTITY);
17+
System.out.println(result);
18+
} catch (ApiException e) {
19+
System.err.println("Exception when calling ScorecardsApi#listScorecardScores");
20+
System.err.println("Status code: " + e.getCode());
21+
System.err.println("Reason: " + e.getResponseBody());
22+
System.err.println("Response headers: " + e.getResponseHeaders());
23+
e.printStackTrace();
24+
}
25+
}
26+
}

0 commit comments

Comments
 (0)