Skip to content

Commit 97ebd2c

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 82fabb35 of spec repo (#830)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 89bcc1a commit 97ebd2c

14 files changed

+855
-12
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.4",
7-
"regenerated": "2022-09-12 15:22:05.725204",
8-
"spec_repo_commit": "dcd92077"
7+
"regenerated": "2022-09-13 07:28:13.750530",
8+
"spec_repo_commit": "82fabb35"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2022-09-12 15:22:05.740102",
13-
"spec_repo_commit": "dcd92077"
12+
"regenerated": "2022-09-13 07:28:13.767666",
13+
"spec_repo_commit": "82fabb35"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 284 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8696,6 +8696,20 @@ components:
86968696
example: UTC
86978697
type: string
86988698
type: object
8699+
SLOCreator:
8700+
description: The creator of the SLO
8701+
nullable: true
8702+
properties:
8703+
email:
8704+
description: Email of the creator.
8705+
type: string
8706+
id:
8707+
description: User ID of the creator.
8708+
type: string
8709+
name:
8710+
description: Name of the creator.
8711+
type: string
8712+
type: object
86998713
SLODeleteResponse:
87008714
description: A response list of all service level objective deleted.
87018715
properties:
@@ -9206,6 +9220,55 @@ components:
92069220
format: int64
92079221
type: integer
92089222
type: object
9223+
SLOOverallStatuses:
9224+
description: Overall status of the SLO by timeframes.
9225+
properties:
9226+
error:
9227+
description: Error message if SLO status or error budget could not be calculated.
9228+
nullable: true
9229+
type: string
9230+
indexed_at:
9231+
description: 'timestamp (UNIX time in seconds) of when the SLO status and
9232+
error budget
9233+
9234+
were calculated.'
9235+
example: 1662496260
9236+
format: int64
9237+
type: integer
9238+
raw_error_budget_remaining:
9239+
$ref: '#/components/schemas/SLORawErrorBudgetRemaining'
9240+
span_precision:
9241+
description: The amount of decimal places the SLI value is accurate to.
9242+
example: 2
9243+
format: int64
9244+
type: integer
9245+
status:
9246+
description: The status of the SLO.
9247+
example: 100
9248+
format: double
9249+
nullable: true
9250+
type: number
9251+
target:
9252+
description: The target of the SLO.
9253+
example: 99
9254+
format: double
9255+
type: number
9256+
timeframe:
9257+
$ref: '#/components/schemas/SLOTimeframe'
9258+
type: object
9259+
SLORawErrorBudgetRemaining:
9260+
description: Error budget remaining for an SLO.
9261+
properties:
9262+
unit:
9263+
description: Error budget remaining unit.
9264+
example: requests
9265+
type: string
9266+
value:
9267+
description: Error budget remaining value.
9268+
example: 60
9269+
format: double
9270+
type: number
9271+
type: object
92099272
SLOResponse:
92109273
description: A service level objective response containing a single service
92119274
level objective.
@@ -9643,6 +9706,38 @@ components:
96439706
- formula
96449707
- dimension
96459708
type: object
9709+
SearchSLOQuery:
9710+
description: 'A metric-based SLO. **Required if type is `metric`**. Note that
9711+
Datadog only allows the sum by aggregator
9712+
9713+
to be used because this will sum up all request counts instead of averaging
9714+
them, or taking the max or
9715+
9716+
min of all of those requests.'
9717+
nullable: true
9718+
properties:
9719+
denominator:
9720+
description: A Datadog metric query for total (valid) events.
9721+
example: sum:my.custom.metric{*}.as_count()
9722+
type: string
9723+
metrics:
9724+
description: 'Metric names used in the query''s numerator and denominator.
9725+
9726+
This field will return null and will be implemented in the next version
9727+
of this endpoint.'
9728+
example:
9729+
- my.custom.metric
9730+
- my.other.custom.metric
9731+
items:
9732+
description: Metric name.
9733+
type: string
9734+
nullable: true
9735+
type: array
9736+
numerator:
9737+
description: A Datadog metric query for good events.
9738+
example: sum:my.custom.metric{type:good}.as_count()
9739+
type: string
9740+
type: object
96469741
SearchSLOResponse:
96479742
description: A search SLO response containing results from the search query.
96489743
properties:
@@ -9671,7 +9766,7 @@ components:
96719766
slo:
96729767
description: SLOs
96739768
items:
9674-
$ref: '#/components/schemas/ServiceLevelObjective'
9769+
$ref: '#/components/schemas/SearchServiceLevelObjective'
96759770
type: array
96769771
type: object
96779772
SearchSLOResponseDataAttributesFacets:
@@ -9801,6 +9896,181 @@ components:
98019896
description: Type of pagination.
98029897
type: string
98039898
type: object
9899+
SearchSLOThreshold:
9900+
description: SLO thresholds (target and optionally warning) for a single time
9901+
window.
9902+
properties:
9903+
target:
9904+
description: 'The target value for the service level indicator within the
9905+
corresponding
9906+
9907+
timeframe.'
9908+
example: 99.9
9909+
format: double
9910+
type: number
9911+
target_display:
9912+
description: 'A string representation of the target that indicates its precision.
9913+
9914+
It uses trailing zeros to show significant decimal places (for example
9915+
`98.00`).
9916+
9917+
9918+
Always included in service level objective responses. Ignored in
9919+
9920+
create/update requests.'
9921+
example: '99.9'
9922+
type: string
9923+
timeframe:
9924+
$ref: '#/components/schemas/SearchSLOTimeframe'
9925+
warning:
9926+
description: The warning value for the service level objective.
9927+
example: 90.0
9928+
format: double
9929+
nullable: true
9930+
type: number
9931+
warning_display:
9932+
description: 'A string representation of the warning target (see the description
9933+
of
9934+
9935+
the `target_display` field for details).
9936+
9937+
9938+
Included in service level objective responses if a warning target exists.
9939+
9940+
Ignored in create/update requests.'
9941+
example: '90.0'
9942+
nullable: true
9943+
type: string
9944+
required:
9945+
- timeframe
9946+
- target
9947+
type: object
9948+
SearchSLOTimeframe:
9949+
description: The SLO time window options.
9950+
enum:
9951+
- 7d
9952+
- 30d
9953+
- 90d
9954+
example: 30d
9955+
type: string
9956+
x-enum-varnames:
9957+
- SEVEN_DAYS
9958+
- THIRTY_DAYS
9959+
- NINETY_DAYS
9960+
SearchServiceLevelObjective:
9961+
description: 'A service level objective object includes a service level indicator,
9962+
thresholds
9963+
9964+
for one or more timeframes, and metadata (`name`, `description`, `tags`, etc.).'
9965+
properties:
9966+
all_tags:
9967+
description: 'A list of tags associated with this service level objective.
9968+
9969+
Always included in service level objective responses (but may be empty).
9970+
9971+
Optional in create/update requests.'
9972+
example:
9973+
- env:prod
9974+
- app:core
9975+
items:
9976+
description: A tag to apply to your SLO.
9977+
type: string
9978+
type: array
9979+
created_at:
9980+
description: 'Creation timestamp (UNIX time in seconds)
9981+
9982+
9983+
Always included in service level objective responses.'
9984+
format: int64
9985+
readOnly: true
9986+
type: integer
9987+
creator:
9988+
$ref: '#/components/schemas/SLOCreator'
9989+
description:
9990+
description: 'A user-defined description of the service level objective.
9991+
9992+
9993+
Always included in service level objective responses (but may be `null`).
9994+
9995+
Optional in create/update requests.'
9996+
nullable: true
9997+
type: string
9998+
groups:
9999+
description: 'A list of (up to 100) monitor groups that narrow the scope
10000+
of a monitor service level objective.
10001+
10002+
10003+
Included in service level objective responses if it is not empty. Optional
10004+
in
10005+
10006+
create/update requests for monitor service level objectives, but may only
10007+
be
10008+
10009+
used when then length of the `monitor_ids` field is one.'
10010+
example:
10011+
- env:prod
10012+
- role:mysql
10013+
items:
10014+
description: A group name, for instance `env:prod`.
10015+
type: string
10016+
nullable: true
10017+
type: array
10018+
id:
10019+
description: 'A unique identifier for the service level objective object.
10020+
10021+
10022+
Always included in service level objective responses.'
10023+
readOnly: true
10024+
type: string
10025+
modified_at:
10026+
description: 'Modification timestamp (UNIX time in seconds)
10027+
10028+
10029+
Always included in service level objective responses.'
10030+
format: int64
10031+
readOnly: true
10032+
type: integer
10033+
monitor_ids:
10034+
description: 'A list of monitor ids that defines the scope of a monitor
10035+
service level
10036+
10037+
objective. **Required if type is `monitor`**.'
10038+
items:
10039+
description: A monitor ID.
10040+
format: int64
10041+
type: integer
10042+
nullable: true
10043+
type: array
10044+
name:
10045+
description: The name of the service level objective object.
10046+
example: Custom Metric SLO
10047+
type: string
10048+
overall_status:
10049+
description: calculated status and error budget remaining.
10050+
items:
10051+
$ref: '#/components/schemas/SLOOverallStatuses'
10052+
type: array
10053+
query:
10054+
$ref: '#/components/schemas/SearchSLOQuery'
10055+
thresholds:
10056+
description: 'The thresholds (timeframes and associated targets) for this
10057+
service level
10058+
10059+
objective object.'
10060+
example:
10061+
- target: 95
10062+
target_display: '95'
10063+
timeframe: 7d
10064+
- target: 95
10065+
target_display: '95'
10066+
timeframe: 30d
10067+
warning: 97
10068+
warning_display: '97'
10069+
items:
10070+
$ref: '#/components/schemas/SearchSLOThreshold'
10071+
type: array
10072+
type:
10073+
$ref: '#/components/schemas/SLOType'
980410074
Series:
980510075
description: 'A metric to submit to Datadog.
980610076

@@ -24378,7 +24648,11 @@ paths:
2437824648
description: Get a list of service level objective objects for your organization.
2437924649
operationId: SearchSLO
2438024650
parameters:
24381-
- description: The query string to filter results based on SLO names.
24651+
- description: 'The query string to filter results based on SLO names.
24652+
24653+
Some examples of queries include `service:<service-name>`
24654+
24655+
and `<slo-name>`.'
2438224656
in: query
2438324657
name: query
2438424658
required: false
@@ -24399,6 +24673,12 @@ paths:
2439924673
schema:
2440024674
format: int64
2440124675
type: integer
24676+
- description: Whether or not to return facet information in the response `[default=false]`.
24677+
in: query
24678+
name: include_facets
24679+
required: false
24680+
schema:
24681+
type: boolean
2440224682
responses:
2440324683
'200':
2440424684
content:
@@ -24428,6 +24708,7 @@ paths:
2442824708
description: The regional site for Datadog customers.
2442924709
enum:
2443024710
- datadoghq.com
24711+
- datadoghq.eu
2443124712
- us3.datadoghq.com
2443224713
- us5.datadoghq.com
2443324714
- ddog-gov.com
@@ -24453,9 +24734,7 @@ paths:
2445324734
summary: Search for SLOs
2445424735
tags:
2445524736
- Service Level Objectives
24456-
x-unstable: '**Note**: Note: This endpoint is in public beta for US regions.
24457-
24458-
It is not currently supported in the EU region.
24737+
x-unstable: '**Note**: This endpoint is in public beta.
2445924738

2446024739
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
2446124740
/api/v1/slo/{slo_id}:

packages/datadog-api-client-common/servers.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,7 @@ export const operationServers: {
148148
new ServerConfiguration<{
149149
site:
150150
| "datadoghq.com"
151+
| "datadoghq.eu"
151152
| "us3.datadoghq.com"
152153
| "us5.datadoghq.com"
153154
| "ddog-gov.com";

0 commit comments

Comments
 (0)