Skip to content

Commit dabf62d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
SLO-3314: Update docs for SLO timeframe values (#1616)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent a1993d3 commit dabf62d

File tree

8 files changed

+20
-11
lines changed

8 files changed

+20
-11
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.6",
7-
"regenerated": "2024-05-10 16:39:44.473648",
8-
"spec_repo_commit": "d6c22916"
7+
"regenerated": "2024-05-14 14:47:46.610140",
8+
"spec_repo_commit": "48746015"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-05-10 16:39:44.491962",
13-
"spec_repo_commit": "d6c22916"
12+
"regenerated": "2024-05-14 14:47:46.629980",
13+
"spec_repo_commit": "48746015"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11498,7 +11498,10 @@ components:
1149811498
- time_slice
1149911499
type: object
1150011500
SLOTimeframe:
11501-
description: The SLO time window options.
11501+
description: 'The SLO time window options. Note that "custom" is not a valid
11502+
option for creating
11503+
11504+
or updating SLOs. It is only used when querying SLO history over custom timeframes.'
1150211505
enum:
1150311506
- 7d
1150411507
- 30d

packages/datadog-api-client-v1/models/SLOOverallStatuses.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ export class SLOOverallStatuses {
4747
*/
4848
"target"?: number;
4949
/**
50-
* The SLO time window options.
50+
* The SLO time window options. Note that "custom" is not a valid option for creating
51+
* or updating SLOs. It is only used when querying SLO history over custom timeframes.
5152
*/
5253
"timeframe"?: SLOTimeframe;
5354

packages/datadog-api-client-v1/models/SLOResponseData.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,8 @@ export class SLOResponseData {
103103
*/
104104
"thresholds"?: Array<SLOThreshold>;
105105
/**
106-
* The SLO time window options.
106+
* The SLO time window options. Note that "custom" is not a valid option for creating
107+
* or updating SLOs. It is only used when querying SLO history over custom timeframes.
107108
*/
108109
"timeframe"?: SLOTimeframe;
109110
/**

packages/datadog-api-client-v1/models/SLOThreshold.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ export class SLOThreshold {
2525
*/
2626
"targetDisplay"?: string;
2727
/**
28-
* The SLO time window options.
28+
* The SLO time window options. Note that "custom" is not a valid option for creating
29+
* or updating SLOs. It is only used when querying SLO history over custom timeframes.
2930
*/
3031
"timeframe": SLOTimeframe;
3132
/**

packages/datadog-api-client-v1/models/SLOTimeframe.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
import { UnparsedObject } from "../../datadog-api-client-common/util";
88

99
/**
10-
* The SLO time window options.
10+
* The SLO time window options. Note that "custom" is not a valid option for creating
11+
* or updating SLOs. It is only used when querying SLO history over custom timeframes.
1112
*/
1213

1314
export type SLOTimeframe =

packages/datadog-api-client-v1/models/ServiceLevelObjective.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,8 @@ export class ServiceLevelObjective {
9999
*/
100100
"thresholds": Array<SLOThreshold>;
101101
/**
102-
* The SLO time window options.
102+
* The SLO time window options. Note that "custom" is not a valid option for creating
103+
* or updating SLOs. It is only used when querying SLO history over custom timeframes.
103104
*/
104105
"timeframe"?: SLOTimeframe;
105106
/**

packages/datadog-api-client-v1/models/ServiceLevelObjectiveRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ export class ServiceLevelObjectiveRequest {
6767
*/
6868
"thresholds": Array<SLOThreshold>;
6969
/**
70-
* The SLO time window options.
70+
* The SLO time window options. Note that "custom" is not a valid option for creating
71+
* or updating SLOs. It is only used when querying SLO history over custom timeframes.
7172
*/
7273
"timeframe"?: SLOTimeframe;
7374
/**

0 commit comments

Comments
 (0)