Skip to content

Commit ab81939

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add missing descriptions to schemas, properties, and array items (#1437)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 54d9cbb commit ab81939

File tree

148 files changed

+186
-272
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

148 files changed

+186
-272
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4307,6 +4307,7 @@ components:
43074307
ip_list:
43084308
description: The client IP addresses matched by the exclusion filter (CIDR notation is supported).
43094309
items:
4310+
description: A single IP address to exclude.
43104311
example: "198.51.100.72"
43114312
type: string
43124313
type: array
@@ -4317,6 +4318,7 @@ components:
43174318
parameters:
43184319
description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
43194320
items:
4321+
description: A request parameter name to exclude from the query string or request body.
43204322
example: "list.search.query"
43214323
type: string
43224324
type: array
@@ -4353,6 +4355,7 @@ components:
43534355
ip_list:
43544356
description: The client IP addresses matched by the exclusion filter (CIDR notation is supported).
43554357
items:
4358+
description: A single IP address to exclude.
43564359
example: "198.51.100.72"
43574360
type: string
43584361
type: array
@@ -4361,6 +4364,7 @@ components:
43614364
parameters:
43624365
description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
43634366
items:
4367+
description: A request parameter name to exclude from the query string or request body.
43644368
example: "list.search.query"
43654369
type: string
43664370
type: array
@@ -4512,6 +4516,7 @@ components:
45124516
ip_list:
45134517
description: The client IP addresses matched by the exclusion filter (CIDR notation is supported).
45144518
items:
4519+
description: A single IP address to exclude.
45154520
example: "198.51.100.72"
45164521
type: string
45174522
type: array
@@ -7348,11 +7353,13 @@ components:
73487353
x-enum-varnames:
73497354
- REFERENCE_TABLES_BATCH_ROWS_QUERY
73507355
BatchRowsQueryRequest:
7356+
description: Request object for querying multiple rows from a reference table by their identifiers.
73517357
properties:
73527358
data:
73537359
$ref: "#/components/schemas/BatchRowsQueryRequestData"
73547360
type: object
73557361
BatchRowsQueryRequestData:
7362+
description: Data object for a batch rows query request.
73567363
properties:
73577364
attributes:
73587365
$ref: "#/components/schemas/BatchRowsQueryRequestDataAttributes"
@@ -7362,22 +7369,27 @@ components:
73627369
- type
73637370
type: object
73647371
BatchRowsQueryRequestDataAttributes:
7372+
description: Attributes for a batch rows query request.
73657373
properties:
73667374
row_ids:
7375+
description: List of row identifiers to query from the reference table.
73677376
example:
73687377
- "row_id_1"
73697378
- "row_id_2"
73707379
items:
7380+
description: A single row identifier.
73717381
type: string
73727382
type: array
73737383
table_id:
7384+
description: Unique identifier of the reference table to query.
73747385
example: "00000000-0000-0000-0000-000000000000"
73757386
type: string
73767387
required:
73777388
- row_ids
73787389
- table_id
73797390
type: object
73807391
BatchRowsQueryResponse:
7392+
description: Response object for a batch rows query against a reference table.
73817393
example:
73827394
data:
73837395
id: 00000000-0000-0000-0000-000000000000
@@ -7394,8 +7406,10 @@ components:
73947406
$ref: "#/components/schemas/BatchRowsQueryResponseData"
73957407
type: object
73967408
BatchRowsQueryResponseData:
7409+
description: Data object for a batch rows query response.
73977410
properties:
73987411
id:
7412+
description: Unique identifier of the batch query.
73997413
type: string
74007414
relationships:
74017415
$ref: "#/components/schemas/BatchRowsQueryResponseDataRelationships"
@@ -7405,11 +7419,13 @@ components:
74057419
- type
74067420
type: object
74077421
BatchRowsQueryResponseDataRelationships:
7422+
description: Relationships of the batch rows query response data.
74087423
properties:
74097424
rows:
74107425
$ref: "#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows"
74117426
type: object
74127427
BatchRowsQueryResponseDataRelationshipsRows:
7428+
description: Relationship data containing the list of matching rows.
74137429
properties:
74147430
data:
74157431
items:
@@ -14945,6 +14961,7 @@ components:
1494514961
description: List of queries to define the environment scope.
1494614962
example: ["staging", "test"]
1494714963
items:
14964+
description: A query string used to match the environment scope.
1494814965
type: string
1494914966
minItems: 1
1495014967
type: array
@@ -15340,6 +15357,7 @@ components:
1534015357
tags:
1534115358
description: User-defined tags for organizing the widget.
1534215359
items:
15360+
description: A single user-defined tag.
1534315361
type: string
1534415362
nullable: true
1534515363
type: array
@@ -15396,6 +15414,7 @@ components:
1539615414
tags:
1539715415
description: Tags to help categorize or filter the page.
1539815416
items:
15417+
description: A single tag for categorizing the page.
1539915418
type: string
1540015419
type: array
1540115420
target:
@@ -23215,6 +23234,7 @@ components:
2321523234
description: List of queries to define the environment scope.
2321623235
example: ["staging", "test"]
2321723236
items:
23237+
description: A query string used to match the environment scope.
2321823238
type: string
2321923239
minItems: 1
2322023240
type: array
@@ -23245,6 +23265,7 @@ components:
2324523265
$ref: "#/components/schemas/EnvironmentsPaginationMetaPage"
2324623266
type: object
2324723267
EnvironmentsPaginationMetaPage:
23268+
description: Pagination metadata for environments list responses.
2324823269
properties:
2324923270
total_count:
2325023271
description: Total number of items.
@@ -25194,6 +25215,7 @@ components:
2519425215
$ref: "#/components/schemas/FeatureFlagsPaginationMetaPage"
2519525216
type: object
2519625217
FeatureFlagsPaginationMetaPage:
25218+
description: Pagination metadata for feature flags list responses.
2519725219
properties:
2519825220
total_count:
2519925221
description: Total number of items.
@@ -41704,6 +41726,7 @@ components:
4170441726
description: A list of component IDs whose output is used as the `input` for this component.
4170541727
example: ["filter-processor"]
4170641728
items:
41729+
description: A component ID referenced as an input source.
4170741730
type: string
4170841731
type: array
4170941732
key_prefix:
@@ -45772,6 +45795,7 @@ components:
4577245795
description: List of log field names to send as indexed fields to Splunk HEC. Available only when `encoding` is `json`.
4577345796
example: ["service", "host"]
4577445797
items:
45798+
description: A log field name to index in Splunk.
4577545799
type: string
4577645800
type: array
4577745801
inputs:
@@ -48289,6 +48313,7 @@ components:
4828948313
name_aliases:
4829048314
description: List of alias names for the permission.
4829148315
items:
48316+
description: An alternative name for the permission.
4829248317
type: string
4829348318
type: array
4829448319
restricted:
@@ -69801,6 +69826,7 @@ components:
6980169826
description: List of queries to define the environment scope.
6980269827
example: ["staging", "test"]
6980369828
items:
69829+
description: A query string used to match the environment scope.
6980469830
type: string
6980569831
minItems: 1
6980669832
type: array
@@ -72285,6 +72311,7 @@ components:
7228572311
example:
7228672312
- "team:my-team"
7228772313
items:
72314+
description: A single user-defined tag.
7228872315
type: string
7228972316
nullable: true
7229072317
type: array

src/datadogV1/api/api_authentication.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ impl AuthenticationAPI {
4343
let builder = reqwest::Client::builder();
4444
#[cfg(not(target_arch = "wasm32"))]
4545
let builder = if let Some(proxy_url) = &config.proxy_url {
46-
builder
47-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
46+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
4847
} else {
4948
builder
5049
};

src/datadogV1/api/api_aws_integration.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,7 @@ impl AWSIntegrationAPI {
193193
let builder = reqwest::Client::builder();
194194
#[cfg(not(target_arch = "wasm32"))]
195195
let builder = if let Some(proxy_url) = &config.proxy_url {
196-
builder
197-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
196+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
198197
} else {
199198
builder
200199
};

src/datadogV1/api/api_aws_logs_integration.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ impl AWSLogsIntegrationAPI {
8989
let builder = reqwest::Client::builder();
9090
#[cfg(not(target_arch = "wasm32"))]
9191
let builder = if let Some(proxy_url) = &config.proxy_url {
92-
builder
93-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
92+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
9493
} else {
9594
builder
9695
};

src/datadogV1/api/api_azure_integration.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,7 @@ impl AzureIntegrationAPI {
7373
let builder = reqwest::Client::builder();
7474
#[cfg(not(target_arch = "wasm32"))]
7575
let builder = if let Some(proxy_url) = &config.proxy_url {
76-
builder
77-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
76+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
7877
} else {
7978
builder
8079
};

src/datadogV1/api/api_dashboard_lists.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,7 @@ impl DashboardListsAPI {
7474
let builder = reqwest::Client::builder();
7575
#[cfg(not(target_arch = "wasm32"))]
7676
let builder = if let Some(proxy_url) = &config.proxy_url {
77-
builder
78-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
77+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
7978
} else {
8079
builder
8180
};

src/datadogV1/api/api_dashboards.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,7 @@ impl DashboardsAPI {
210210
let builder = reqwest::Client::builder();
211211
#[cfg(not(target_arch = "wasm32"))]
212212
let builder = if let Some(proxy_url) = &config.proxy_url {
213-
builder
214-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
213+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
215214
} else {
216215
builder
217216
};

src/datadogV1/api/api_downtimes.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,7 @@ impl DowntimesAPI {
116116
let builder = reqwest::Client::builder();
117117
#[cfg(not(target_arch = "wasm32"))]
118118
let builder = if let Some(proxy_url) = &config.proxy_url {
119-
builder
120-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
119+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
121120
} else {
122121
builder
123122
};

src/datadogV1/api/api_events.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,8 +117,7 @@ impl EventsAPI {
117117
let builder = reqwest::Client::builder();
118118
#[cfg(not(target_arch = "wasm32"))]
119119
let builder = if let Some(proxy_url) = &config.proxy_url {
120-
builder
121-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
120+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
122121
} else {
123122
builder
124123
};

src/datadogV1/api/api_gcp_integration.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,7 @@ impl GCPIntegrationAPI {
6565
let builder = reqwest::Client::builder();
6666
#[cfg(not(target_arch = "wasm32"))]
6767
let builder = if let Some(proxy_url) = &config.proxy_url {
68-
builder
69-
.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
68+
builder.proxy(reqwest::Proxy::all(proxy_url).expect("Failed to parse proxy URL"))
7069
} else {
7170
builder
7271
};

0 commit comments

Comments
 (0)