From 1f18fad0a756a6438f274798591c3df7dd3bfac7 Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Tue, 7 Mar 2023 22:43:09 +0000 Subject: [PATCH] Clarify a required spec for downtime scope (#1901) Co-authored-by: ci.datadog-api-spec --- .apigentools-info | 8 ++++---- .generator/schemas/v1/openapi.yaml | 9 ++++++--- api/datadogV1/model_cancel_downtimes_by_scope_request.go | 2 +- api/datadogV1/model_downtime.go | 2 +- api/datadogV1/model_downtime_child.go | 2 +- 5 files changed, 13 insertions(+), 10 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index 6da50e1272f..5fc74560cd1 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -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" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 155ca08eafe..fa316c50298 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -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`. @@ -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`. @@ -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`. diff --git a/api/datadogV1/model_cancel_downtimes_by_scope_request.go b/api/datadogV1/model_cancel_downtimes_by_scope_request.go index 097534aaac3..65c668df114 100644 --- a/api/datadogV1/model_cancel_downtimes_by_scope_request.go +++ b/api/datadogV1/model_cancel_downtimes_by_scope_request.go @@ -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"` diff --git a/api/datadogV1/model_downtime.go b/api/datadogV1/model_downtime.go index 5e61c674486..f3216afa36f 100644 --- a/api/datadogV1/model_downtime.go +++ b/api/datadogV1/model_downtime.go @@ -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"` diff --git a/api/datadogV1/model_downtime_child.go b/api/datadogV1/model_downtime_child.go index 0a23c3e2863..cb27a21d822 100644 --- a/api/datadogV1/model_downtime_child.go +++ b/api/datadogV1/model_downtime_child.go @@ -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"`