Skip to content

Commit f366706

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
SLO-3314: Update docs for SLO timeframe values (#2283)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 2f9a021 commit f366706

File tree

8 files changed

+22
-11
lines changed

8 files changed

+22
-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:57.617582",
8-
"spec_repo_commit": "d6c22916"
7+
"regenerated": "2024-05-14 14:47:45.391704",
8+
"spec_repo_commit": "48746015"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-05-10 16:39:57.635288",
13-
"spec_repo_commit": "d6c22916"
12+
"regenerated": "2024-05-14 14:47:45.409386",
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

src/main/java/com/datadog/api/client/v1/model/SLOOverallStatuses.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,8 @@ public SLOOverallStatuses timeframe(SLOTimeframe timeframe) {
295295
}
296296

297297
/**
298-
* The SLO time window options.
298+
* The SLO time window options. Note that "custom" is not a valid option for creating or updating
299+
* SLOs. It is only used when querying SLO history over custom timeframes.
299300
*
300301
* @return timeframe
301302
*/

src/main/java/com/datadog/api/client/v1/model/SLOResponseData.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,8 @@ public SLOResponseData timeframe(SLOTimeframe timeframe) {
474474
}
475475

476476
/**
477-
* The SLO time window options.
477+
* The SLO time window options. Note that "custom" is not a valid option for creating or updating
478+
* SLOs. It is only used when querying SLO history over custom timeframes.
478479
*
479480
* @return timeframe
480481
*/

src/main/java/com/datadog/api/client/v1/model/SLOThreshold.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ public SLOThreshold timeframe(SLOTimeframe timeframe) {
106106
}
107107

108108
/**
109-
* The SLO time window options.
109+
* The SLO time window options. Note that "custom" is not a valid option for creating or updating
110+
* SLOs. It is only used when querying SLO history over custom timeframes.
110111
*
111112
* @return timeframe
112113
*/

src/main/java/com/datadog/api/client/v1/model/SLOTimeframe.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818
import java.util.HashSet;
1919
import java.util.Set;
2020

21-
/** The SLO time window options. */
21+
/**
22+
* The SLO time window options. Note that "custom" is not a valid option for creating or updating
23+
* SLOs. It is only used when querying SLO history over custom timeframes.
24+
*/
2225
@JsonSerialize(using = SLOTimeframe.SLOTimeframeSerializer.class)
2326
public class SLOTimeframe extends ModelEnum<String> {
2427

src/main/java/com/datadog/api/client/v1/model/ServiceLevelObjective.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -451,7 +451,8 @@ public ServiceLevelObjective timeframe(SLOTimeframe timeframe) {
451451
}
452452

453453
/**
454-
* The SLO time window options.
454+
* The SLO time window options. Note that "custom" is not a valid option for creating or updating
455+
* SLOs. It is only used when querying SLO history over custom timeframes.
455456
*
456457
* @return timeframe
457458
*/

src/main/java/com/datadog/api/client/v1/model/ServiceLevelObjectiveRequest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,8 @@ public ServiceLevelObjectiveRequest timeframe(SLOTimeframe timeframe) {
344344
}
345345

346346
/**
347-
* The SLO time window options.
347+
* The SLO time window options. Note that "custom" is not a valid option for creating or updating
348+
* SLOs. It is only used when querying SLO history over custom timeframes.
348349
*
349350
* @return timeframe
350351
*/

0 commit comments

Comments
 (0)