Skip to content

Commit c5c9b81

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

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:45.913034",
8-
"spec_repo_commit": "d6c22916"
7+
"regenerated": "2024-05-14 14:47:49.021323",
8+
"spec_repo_commit": "48746015"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-05-10 16:39:45.942353",
13-
"spec_repo_commit": "d6c22916"
12+
"regenerated": "2024-05-14 14:47:49.038170",
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/datadog_api_client/v1/model/service_level_objective.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ def __init__(
172172
objective object.
173173
:type thresholds: [SLOThreshold]
174174
175-
:param timeframe: The SLO time window options.
175+
:param timeframe: The SLO time window options. Note that "custom" is not a valid option for creating
176+
or updating SLOs. It is only used when querying SLO history over custom timeframes.
176177
:type timeframe: SLOTimeframe, optional
177178
178179
:param type: The type of the service level objective.

src/datadog_api_client/v1/model/service_level_objective_request.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,8 @@ def __init__(
123123
objective object.
124124
:type thresholds: [SLOThreshold]
125125
126-
:param timeframe: The SLO time window options.
126+
:param timeframe: The SLO time window options. Note that "custom" is not a valid option for creating
127+
or updating SLOs. It is only used when querying SLO history over custom timeframes.
127128
:type timeframe: SLOTimeframe, optional
128129
129130
:param type: The type of the service level objective.

src/datadog_api_client/v1/model/slo_overall_statuses.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ def __init__(
9292
:param target: The target of the SLO.
9393
:type target: float, optional
9494
95-
:param timeframe: The SLO time window options.
95+
:param timeframe: The SLO time window options. Note that "custom" is not a valid option for creating
96+
or updating SLOs. It is only used when querying SLO history over custom timeframes.
9697
:type timeframe: SLOTimeframe, optional
9798
"""
9899
if error is not unset:

src/datadog_api_client/v1/model/slo_response_data.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,8 @@ def __init__(
178178
objective object.
179179
:type thresholds: [SLOThreshold], optional
180180
181-
:param timeframe: The SLO time window options.
181+
:param timeframe: The SLO time window options. Note that "custom" is not a valid option for creating
182+
or updating SLOs. It is only used when querying SLO history over custom timeframes.
182183
:type timeframe: SLOTimeframe, optional
183184
184185
:param type: The type of the service level objective.

src/datadog_api_client/v1/model/slo_threshold.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,8 @@ def __init__(
6161
create/update requests.
6262
:type target_display: str, optional
6363
64-
:param timeframe: The SLO time window options.
64+
:param timeframe: The SLO time window options. Note that "custom" is not a valid option for creating
65+
or updating SLOs. It is only used when querying SLO history over custom timeframes.
6566
:type timeframe: SLOTimeframe
6667
6768
:param warning: The warning value for the service level objective.

src/datadog_api_client/v1/model/slo_timeframe.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414

1515
class SLOTimeframe(ModelSimple):
1616
"""
17-
The SLO time window options.
17+
The SLO time window options. Note that "custom" is not a valid option for creating
18+
or updating SLOs. It is only used when querying SLO history over custom timeframes.
1819
1920
:param value: Must be one of ["7d", "30d", "90d", "custom"].
2021
:type value: str

0 commit comments

Comments
 (0)