diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 2c27fbce2b..d14c3e4112 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -4307,6 +4307,7 @@ components: ip_list: description: The client IP addresses matched by the exclusion filter (CIDR notation is supported). items: + description: A single IP address to exclude. example: "198.51.100.72" type: string type: array @@ -4317,6 +4318,7 @@ components: parameters: 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. items: + description: A request parameter name to exclude from the query string or request body. example: "list.search.query" type: string type: array @@ -4353,6 +4355,7 @@ components: ip_list: description: The client IP addresses matched by the exclusion filter (CIDR notation is supported). items: + description: A single IP address to exclude. example: "198.51.100.72" type: string type: array @@ -4361,6 +4364,7 @@ components: parameters: 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. items: + description: A request parameter name to exclude from the query string or request body. example: "list.search.query" type: string type: array @@ -4512,6 +4516,7 @@ components: ip_list: description: The client IP addresses matched by the exclusion filter (CIDR notation is supported). items: + description: A single IP address to exclude. example: "198.51.100.72" type: string type: array @@ -7348,11 +7353,13 @@ components: x-enum-varnames: - REFERENCE_TABLES_BATCH_ROWS_QUERY BatchRowsQueryRequest: + description: Request object for querying multiple rows from a reference table by their identifiers. properties: data: $ref: "#/components/schemas/BatchRowsQueryRequestData" type: object BatchRowsQueryRequestData: + description: Data object for a batch rows query request. properties: attributes: $ref: "#/components/schemas/BatchRowsQueryRequestDataAttributes" @@ -7362,15 +7369,19 @@ components: - type type: object BatchRowsQueryRequestDataAttributes: + description: Attributes for a batch rows query request. properties: row_ids: + description: List of row identifiers to query from the reference table. example: - "row_id_1" - "row_id_2" items: + description: A single row identifier. type: string type: array table_id: + description: Unique identifier of the reference table to query. example: "00000000-0000-0000-0000-000000000000" type: string required: @@ -7378,6 +7389,7 @@ components: - table_id type: object BatchRowsQueryResponse: + description: Response object for a batch rows query against a reference table. example: data: id: 00000000-0000-0000-0000-000000000000 @@ -7394,8 +7406,10 @@ components: $ref: "#/components/schemas/BatchRowsQueryResponseData" type: object BatchRowsQueryResponseData: + description: Data object for a batch rows query response. properties: id: + description: Unique identifier of the batch query. type: string relationships: $ref: "#/components/schemas/BatchRowsQueryResponseDataRelationships" @@ -7405,11 +7419,13 @@ components: - type type: object BatchRowsQueryResponseDataRelationships: + description: Relationships of the batch rows query response data. properties: rows: $ref: "#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows" type: object BatchRowsQueryResponseDataRelationshipsRows: + description: Relationship data containing the list of matching rows. properties: data: items: @@ -14945,6 +14961,7 @@ components: description: List of queries to define the environment scope. example: ["staging", "test"] items: + description: A query string used to match the environment scope. type: string minItems: 1 type: array @@ -15340,6 +15357,7 @@ components: tags: description: User-defined tags for organizing the widget. items: + description: A single user-defined tag. type: string nullable: true type: array @@ -15396,6 +15414,7 @@ components: tags: description: Tags to help categorize or filter the page. items: + description: A single tag for categorizing the page. type: string type: array target: @@ -23215,6 +23234,7 @@ components: description: List of queries to define the environment scope. example: ["staging", "test"] items: + description: A query string used to match the environment scope. type: string minItems: 1 type: array @@ -23245,6 +23265,7 @@ components: $ref: "#/components/schemas/EnvironmentsPaginationMetaPage" type: object EnvironmentsPaginationMetaPage: + description: Pagination metadata for environments list responses. properties: total_count: description: Total number of items. @@ -25194,6 +25215,7 @@ components: $ref: "#/components/schemas/FeatureFlagsPaginationMetaPage" type: object FeatureFlagsPaginationMetaPage: + description: Pagination metadata for feature flags list responses. properties: total_count: description: Total number of items. @@ -41704,6 +41726,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: A component ID referenced as an input source. type: string type: array key_prefix: @@ -45772,6 +45795,7 @@ components: description: List of log field names to send as indexed fields to Splunk HEC. Available only when `encoding` is `json`. example: ["service", "host"] items: + description: A log field name to index in Splunk. type: string type: array inputs: @@ -48289,6 +48313,7 @@ components: name_aliases: description: List of alias names for the permission. items: + description: An alternative name for the permission. type: string type: array restricted: @@ -69801,6 +69826,7 @@ components: description: List of queries to define the environment scope. example: ["staging", "test"] items: + description: A query string used to match the environment scope. type: string minItems: 1 type: array @@ -72285,6 +72311,7 @@ components: example: - "team:my-team" items: + description: A single user-defined tag. type: string nullable: true type: array diff --git a/src/datadog_api_client/v2/model/batch_rows_query_request.py b/src/datadog_api_client/v2/model/batch_rows_query_request.py index f1d2823956..91fc222add 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_request.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_request.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[BatchRowsQueryRequestData, UnsetType] = unset, **kwargs): """ + Request object for querying multiple rows from a reference table by their identifiers. - - :param data: + :param data: Data object for a batch rows query request. :type data: BatchRowsQueryRequestData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/batch_rows_query_request_data.py b/src/datadog_api_client/v2/model/batch_rows_query_request_data.py index 879ce6f7c3..f0b56980d7 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_request_data.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_request_data.py @@ -43,9 +43,9 @@ def __init__( **kwargs, ): """ + Data object for a batch rows query request. - - :param attributes: + :param attributes: Attributes for a batch rows query request. :type attributes: BatchRowsQueryRequestDataAttributes, optional :param type: Resource type identifier for batch queries of reference table rows. diff --git a/src/datadog_api_client/v2/model/batch_rows_query_request_data_attributes.py b/src/datadog_api_client/v2/model/batch_rows_query_request_data_attributes.py index 3edf53ba81..3e03b532c8 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_request_data_attributes.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_request_data_attributes.py @@ -26,12 +26,12 @@ def openapi_types(_): def __init__(self_, row_ids: List[str], table_id: str, **kwargs): """ + Attributes for a batch rows query request. - - :param row_ids: + :param row_ids: List of row identifiers to query from the reference table. :type row_ids: [str] - :param table_id: + :param table_id: Unique identifier of the reference table to query. :type table_id: str """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/batch_rows_query_response.py b/src/datadog_api_client/v2/model/batch_rows_query_response.py index 5b1e5afc0c..ab940cd107 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_response.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_response.py @@ -32,9 +32,9 @@ def openapi_types(_): def __init__(self_, data: Union[BatchRowsQueryResponseData, UnsetType] = unset, **kwargs): """ + Response object for a batch rows query against a reference table. - - :param data: + :param data: Data object for a batch rows query response. :type data: BatchRowsQueryResponseData, optional """ if data is not unset: diff --git a/src/datadog_api_client/v2/model/batch_rows_query_response_data.py b/src/datadog_api_client/v2/model/batch_rows_query_response_data.py index 33b6d8fa69..5e8c565985 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_response_data.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_response_data.py @@ -48,12 +48,12 @@ def __init__( **kwargs, ): """ + Data object for a batch rows query response. - - :param id: + :param id: Unique identifier of the batch query. :type id: str, optional - :param relationships: + :param relationships: Relationships of the batch rows query response data. :type relationships: BatchRowsQueryResponseDataRelationships, optional :param type: Resource type identifier for batch queries of reference table rows. diff --git a/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships.py b/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships.py index 0da1e8ea1e..8af5d2718f 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships.py @@ -36,9 +36,9 @@ def openapi_types(_): def __init__(self_, rows: Union[BatchRowsQueryResponseDataRelationshipsRows, UnsetType] = unset, **kwargs): """ + Relationships of the batch rows query response data. - - :param rows: + :param rows: Relationship data containing the list of matching rows. :type rows: BatchRowsQueryResponseDataRelationshipsRows, optional """ if rows is not unset: diff --git a/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships_rows.py b/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships_rows.py index 25c48117ca..1cf71bd663 100644 --- a/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships_rows.py +++ b/src/datadog_api_client/v2/model/batch_rows_query_response_data_relationships_rows.py @@ -32,7 +32,7 @@ def openapi_types(_): def __init__(self_, data: Union[List[TableRowResourceIdentifier], UnsetType] = unset, **kwargs): """ - + Relationship data containing the list of matching rows. :param data: :type data: [TableRowResourceIdentifier], optional diff --git a/src/datadog_api_client/v2/model/environments_pagination_meta.py b/src/datadog_api_client/v2/model/environments_pagination_meta.py index f76c6985d2..28d0086e34 100644 --- a/src/datadog_api_client/v2/model/environments_pagination_meta.py +++ b/src/datadog_api_client/v2/model/environments_pagination_meta.py @@ -34,7 +34,7 @@ def __init__(self_, page: Union[EnvironmentsPaginationMetaPage, UnsetType] = uns """ Pagination metadata for environments. - :param page: + :param page: Pagination metadata for environments list responses. :type page: EnvironmentsPaginationMetaPage, optional """ if page is not unset: diff --git a/src/datadog_api_client/v2/model/environments_pagination_meta_page.py b/src/datadog_api_client/v2/model/environments_pagination_meta_page.py index 26ccaa7fc0..106f8d40c9 100644 --- a/src/datadog_api_client/v2/model/environments_pagination_meta_page.py +++ b/src/datadog_api_client/v2/model/environments_pagination_meta_page.py @@ -30,7 +30,7 @@ def __init__( self_, total_count: Union[int, UnsetType] = unset, total_filtered_count: Union[int, UnsetType] = unset, **kwargs ): """ - + Pagination metadata for environments list responses. :param total_count: Total number of items. :type total_count: int, optional diff --git a/src/datadog_api_client/v2/model/feature_flags_pagination_meta.py b/src/datadog_api_client/v2/model/feature_flags_pagination_meta.py index fe44deb941..e359740213 100644 --- a/src/datadog_api_client/v2/model/feature_flags_pagination_meta.py +++ b/src/datadog_api_client/v2/model/feature_flags_pagination_meta.py @@ -34,7 +34,7 @@ def __init__(self_, page: Union[FeatureFlagsPaginationMetaPage, UnsetType] = uns """ Pagination metadata for feature flags. - :param page: + :param page: Pagination metadata for feature flags list responses. :type page: FeatureFlagsPaginationMetaPage, optional """ if page is not unset: diff --git a/src/datadog_api_client/v2/model/feature_flags_pagination_meta_page.py b/src/datadog_api_client/v2/model/feature_flags_pagination_meta_page.py index 3f0f693cd6..6994d14338 100644 --- a/src/datadog_api_client/v2/model/feature_flags_pagination_meta_page.py +++ b/src/datadog_api_client/v2/model/feature_flags_pagination_meta_page.py @@ -30,7 +30,7 @@ def __init__( self_, total_count: Union[int, UnsetType] = unset, total_filtered_count: Union[int, UnsetType] = unset, **kwargs ): """ - + Pagination metadata for feature flags list responses. :param total_count: Total number of items. :type total_count: int, optional