Skip to content

Commit e598af1

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

12 files changed

+46
-19
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/main/java/com/datadog/api/client/v2/model/BatchRowsQueryRequest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Map;
1717
import java.util.Objects;
1818

19-
/** */
19+
/** Request object for querying multiple rows from a reference table by their identifiers. */
2020
@JsonPropertyOrder({BatchRowsQueryRequest.JSON_PROPERTY_DATA})
2121
@jakarta.annotation.Generated(
2222
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,7 +32,7 @@ public BatchRowsQueryRequest data(BatchRowsQueryRequestData data) {
3232
}
3333

3434
/**
35-
* Getdata
35+
* Data object for a batch rows query request.
3636
*
3737
* @return data
3838
*/

‎src/main/java/com/datadog/api/client/v2/model/BatchRowsQueryRequestData.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/** */
20+
/** Data object for a batch rows query request. */
2121
@JsonPropertyOrder({
2222
BatchRowsQueryRequestData.JSON_PROPERTY_ATTRIBUTES,
2323
BatchRowsQueryRequestData.JSON_PROPERTY_TYPE
@@ -48,7 +48,7 @@ public BatchRowsQueryRequestData attributes(BatchRowsQueryRequestDataAttributes
4848
}
4949

5050
/**
51-
* Getattributes
51+
* Attributes for a batch rows query request.
5252
*
5353
* @return attributes
5454
*/

‎src/main/java/com/datadog/api/client/v2/model/BatchRowsQueryRequestDataAttributes.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
import java.util.Map;
2020
import java.util.Objects;
2121

22-
/** */
22+
/** Attributes for a batch rows query request. */
2323
@JsonPropertyOrder({
2424
BatchRowsQueryRequestDataAttributes.JSON_PROPERTY_ROW_IDS,
2525
BatchRowsQueryRequestDataAttributes.JSON_PROPERTY_TABLE_ID
@@ -55,7 +55,7 @@ public BatchRowsQueryRequestDataAttributes addRowIdsItem(String rowIdsItem) {
5555
}
5656

5757
/**
58-
* GetrowIds
58+
* List of row identifiers to query from the reference table.
5959
*
6060
* @return rowIds
6161
*/
@@ -75,7 +75,7 @@ public BatchRowsQueryRequestDataAttributes tableId(String tableId) {
7575
}
7676

7777
/**
78-
* GettableId
78+
* Unique identifier of the reference table to query.
7979
*
8080
* @return tableId
8181
*/

‎src/main/java/com/datadog/api/client/v2/model/BatchRowsQueryResponse.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Map;
1717
import java.util.Objects;
1818

19-
/** */
19+
/** Response object for a batch rows query against a reference table. */
2020
@JsonPropertyOrder({BatchRowsQueryResponse.JSON_PROPERTY_DATA})
2121
@jakarta.annotation.Generated(
2222
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,7 +32,7 @@ public BatchRowsQueryResponse data(BatchRowsQueryResponseData data) {
3232
}
3333

3434
/**
35-
* Getdata
35+
* Data object for a batch rows query response.
3636
*
3737
* @return data
3838
*/

‎src/main/java/com/datadog/api/client/v2/model/BatchRowsQueryResponseData.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import java.util.Map;
1818
import java.util.Objects;
1919

20-
/** */
20+
/** Data object for a batch rows query response. */
2121
@JsonPropertyOrder({
2222
BatchRowsQueryResponseData.JSON_PROPERTY_ID,
2323
BatchRowsQueryResponseData.JSON_PROPERTY_RELATIONSHIPS,
@@ -51,7 +51,7 @@ public BatchRowsQueryResponseData id(String id) {
5151
}
5252

5353
/**
54-
* Getid
54+
* Unique identifier of the batch query.
5555
*
5656
* @return id
5757
*/
@@ -74,7 +74,7 @@ public BatchRowsQueryResponseData relationships(
7474
}
7575

7676
/**
77-
* Getrelationships
77+
* Relationships of the batch rows query response data.
7878
*
7979
* @return relationships
8080
*/

‎src/main/java/com/datadog/api/client/v2/model/BatchRowsQueryResponseDataRelationships.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Map;
1717
import java.util.Objects;
1818

19-
/** */
19+
/** Relationships of the batch rows query response data. */
2020
@JsonPropertyOrder({BatchRowsQueryResponseDataRelationships.JSON_PROPERTY_ROWS})
2121
@jakarta.annotation.Generated(
2222
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -33,7 +33,7 @@ public BatchRowsQueryResponseDataRelationships rows(
3333
}
3434

3535
/**
36-
* Getrows
36+
* Relationship data containing the list of matching rows.
3737
*
3838
* @return rows
3939
*/

‎src/main/java/com/datadog/api/client/v2/model/BatchRowsQueryResponseDataRelationshipsRows.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
import java.util.Map;
1919
import java.util.Objects;
2020

21-
/** */
21+
/** Relationship data containing the list of matching rows. */
2222
@JsonPropertyOrder({BatchRowsQueryResponseDataRelationshipsRows.JSON_PROPERTY_DATA})
2323
@jakarta.annotation.Generated(
2424
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")

‎src/main/java/com/datadog/api/client/v2/model/EnvironmentsPaginationMeta.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public EnvironmentsPaginationMeta page(EnvironmentsPaginationMetaPage page) {
3232
}
3333

3434
/**
35-
* Getpage
35+
* Pagination metadata for environments list responses.
3636
*
3737
* @return page
3838
*/

‎src/main/java/com/datadog/api/client/v2/model/EnvironmentsPaginationMetaPage.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
import java.util.Map;
1717
import java.util.Objects;
1818

19-
/** */
19+
/** Pagination metadata for environments list responses. */
2020
@JsonPropertyOrder({
2121
EnvironmentsPaginationMetaPage.JSON_PROPERTY_TOTAL_COUNT,
2222
EnvironmentsPaginationMetaPage.JSON_PROPERTY_TOTAL_FILTERED_COUNT

0 commit comments

Comments
 (0)