Skip to content

Commit ad33729

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Clarify a required spec for downtime scope (#1369)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent b463c86 commit ad33729

File tree

5 files changed

+13
-10
lines changed

5 files changed

+13
-10
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": "2023-03-07 18:54:18.529425",
8-
"spec_repo_commit": "f09bf63c"
7+
"regenerated": "2023-03-07 22:36:00.834683",
8+
"spec_repo_commit": "73e66c9a"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-03-07 18:54:18.541358",
13-
"spec_repo_commit": "f09bf63c"
12+
"regenerated": "2023-03-07 22:36:00.847119",
13+
"spec_repo_commit": "73e66c9a"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,8 @@ components:
697697
description: Cancel downtimes according to scope.
698698
properties:
699699
scope:
700-
description: 'The scope(s) to which the downtime applies. For example, `host:app2`.
700+
description: 'The scope(s) to which the downtime applies and must be in
701+
`key:value` format. For example, `host:app2`.
701702

702703
Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
703704

@@ -1678,7 +1679,8 @@ components:
16781679
recurrence:
16791680
$ref: '#/components/schemas/DowntimeRecurrence'
16801681
scope:
1681-
description: 'The scope(s) to which the downtime applies. For example, `host:app2`.
1682+
description: 'The scope(s) to which the downtime applies and must be in
1683+
`key:value` format. For example, `host:app2`.
16821684

16831685
Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
16841686

@@ -1812,7 +1814,8 @@ components:
18121814
recurrence:
18131815
$ref: '#/components/schemas/DowntimeRecurrence'
18141816
scope:
1815-
description: 'The scope(s) to which the downtime applies. For example, `host:app2`.
1817+
description: 'The scope(s) to which the downtime applies and must be in
1818+
`key:value` format. For example, `host:app2`.
18161819

18171820
Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
18181821

src/datadog_api_client/v1/model/cancel_downtimes_by_scope_request.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def __init__(self_, scope: str, **kwargs):
2525
"""
2626
Cancel downtimes according to scope.
2727
28-
:param scope: The scope(s) to which the downtime applies. For example, ``host:app2``.
28+
:param scope: The scope(s) to which the downtime applies and must be in ``key:value`` format. For example, ``host:app2``.
2929
Provide multiple scopes as a comma-separated list like ``env:dev,env:prod``.
3030
The resulting downtime applies to sources that matches ALL provided scopes ( ``env:dev`` **AND** ``env:prod`` ).
3131
:type scope: str

src/datadog_api_client/v1/model/downtime.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ def __init__(
167167
:param recurrence: An object defining the recurrence of the downtime.
168168
:type recurrence: DowntimeRecurrence, none_type, optional
169169
170-
:param scope: The scope(s) to which the downtime applies. For example, ``host:app2``.
170+
:param scope: The scope(s) to which the downtime applies and must be in ``key:value`` format. For example, ``host:app2``.
171171
Provide multiple scopes as a comma-separated list like ``env:dev,env:prod``.
172172
The resulting downtime applies to sources that matches ALL provided scopes ( ``env:dev`` **AND** ``env:prod`` ).
173173
:type scope: [str], optional

src/datadog_api_client/v1/model/downtime_child.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ def __init__(
156156
:param recurrence: An object defining the recurrence of the downtime.
157157
:type recurrence: DowntimeRecurrence, none_type, optional
158158
159-
:param scope: The scope(s) to which the downtime applies. For example, ``host:app2``.
159+
:param scope: The scope(s) to which the downtime applies and must be in ``key:value`` format. For example, ``host:app2``.
160160
Provide multiple scopes as a comma-separated list like ``env:dev,env:prod``.
161161
The resulting downtime applies to sources that matches ALL provided scopes ( ``env:dev`` **AND** ``env:prod`` ).
162162
:type scope: [str], optional

0 commit comments

Comments
 (0)