Skip to content

Commit 627b75b

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Clarify a required spec for downtime scope (#1058)
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 fcc7888 commit 627b75b

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:27.602100",
8-
"spec_repo_commit": "f09bf63c"
7+
"regenerated": "2023-03-07 22:36:05.692522",
8+
"spec_repo_commit": "73e66c9a"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-03-07 18:54:27.614041",
13-
"spec_repo_commit": "f09bf63c"
12+
"regenerated": "2023-03-07 22:36:05.705736",
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

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1111
*/
1212
export class CancelDowntimesByScopeRequest {
1313
/**
14-
* The scope(s) to which the downtime applies. For example, `host:app2`.
14+
* The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
1515
* Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
1616
* The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
1717
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ export class Downtime {
8181
*/
8282
"recurrence"?: DowntimeRecurrence;
8383
/**
84-
* The scope(s) to which the downtime applies. For example, `host:app2`.
84+
* The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
8585
* Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
8686
* The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
8787
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export class DowntimeChild {
7373
*/
7474
"recurrence"?: DowntimeRecurrence;
7575
/**
76-
* The scope(s) to which the downtime applies. For example, `host:app2`.
76+
* The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
7777
* Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
7878
* The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
7979
*/

0 commit comments

Comments
 (0)