Skip to content

Commit

Permalink
Clarify a required spec for downtime scope (#1901)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec authored Mar 7, 2023
1 parent 8585989 commit 1f18fad
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 10 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.4",
"regenerated": "2023-03-07 18:54:26.407374",
"spec_repo_commit": "f09bf63c"
"regenerated": "2023-03-07 22:36:00.324327",
"spec_repo_commit": "73e66c9a"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2023-03-07 18:54:26.419846",
"spec_repo_commit": "f09bf63c"
"regenerated": "2023-03-07 22:36:00.336988",
"spec_repo_commit": "73e66c9a"
}
}
}
9 changes: 6 additions & 3 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -697,7 +697,8 @@ components:
description: Cancel downtimes according to scope.
properties:
scope:
description: 'The scope(s) to which the downtime applies. For example, `host:app2`.
description: 'The scope(s) to which the downtime applies and must be in
`key:value` format. For example, `host:app2`.

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

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

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_cancel_downtimes_by_scope_request.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (

// CancelDowntimesByScopeRequest Cancel downtimes according to scope.
type CancelDowntimesByScopeRequest struct {
// The scope(s) to which the downtime applies. For example, `host:app2`.
// The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
// Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
// The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
Scope string `json:"scope"`
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_downtime.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ type Downtime struct {
ParentId datadog.NullableInt64 `json:"parent_id,omitempty"`
// An object defining the recurrence of the downtime.
Recurrence NullableDowntimeRecurrence `json:"recurrence,omitempty"`
// The scope(s) to which the downtime applies. For example, `host:app2`.
// The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
// Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
// The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
Scope []string `json:"scope,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_downtime_child.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ type DowntimeChild struct {
ParentId datadog.NullableInt64 `json:"parent_id,omitempty"`
// An object defining the recurrence of the downtime.
Recurrence NullableDowntimeRecurrence `json:"recurrence,omitempty"`
// The scope(s) to which the downtime applies. For example, `host:app2`.
// The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
// Provide multiple scopes as a comma-separated list like `env:dev,env:prod`.
// The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`).
Scope []string `json:"scope,omitempty"`
Expand Down

0 comments on commit 1f18fad

Please sign in to comment.