Add examples to Reference Tables API documentation, update cloud file and local file metadata (#2924)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -57,7 +57,6 @@
                 "test_tag",
             ],
         ),
-        id="00000000-0000-0000-0000-000000000000",
         type=PatchTableRequestDataType.REFERENCE_TABLE,
     ),
 )

examples/v2/reference-tables/UpdateReferenceTable.py

@@ -233,7 +233,12 @@ def create_reference_table(
     ) -> TableResultV2:
         """Create reference table.
 
-        Create a new reference table. You can provide data in two ways: 1) Call POST api/v2/reference-tables/upload first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this POST endpoint with the upload_id in file_metadata, OR 2) Provide access_details in file_metadata pointing to a CSV file in cloud storage (Amazon S3, Azure Blob Storage, or GCP Cloud Storage).
+        Creates a reference table. You can provide data in two ways:
+
+        #. Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the CSV data
+           (not the file itself) in chunks to each URL in the request body. Finally, call this
+           POST endpoint with ``upload_id`` in ``file_metadata``.
+        #. Provide ``access_details`` in ``file_metadata`` pointing to a CSV file in cloud storage.
 
         :type body: CreateTableRequest
         :rtype: TableResultV2
@@ -267,7 +272,7 @@ def delete_table(
 
         Delete a reference table by ID
 
-        :param id: The ID of the reference table to delete
+        :param id: Unique identifier of the reference table to delete
         :type id: str
         :rtype: None
         """
@@ -285,7 +290,7 @@ def get_rows_by_id(
 
         Get reference table rows by their primary key values.
 
-        :param id: The ID of the reference table
+        :param id: Unique identifier of the reference table to get rows from
         :type id: str
         :param row_id: List of row IDs (primary key values) to retrieve from the reference table.
         :type row_id: [str]
@@ -306,7 +311,7 @@ def get_table(
 
         Get a reference table by ID
 
-        :param id: The ID of the reference table to retrieve
+        :param id: Unique identifier of the reference table to retrieve
         :type id: str
         :rtype: TableResultV2
         """
@@ -333,7 +338,7 @@ def list_tables(
         :type page_limit: int, optional
         :param page_offset: Number of tables to skip for pagination.
         :type page_offset: int, optional
-        :param sort: Sort field and direction. Use field name for ascending, prefix with "-" for descending.
+        :param sort: Sort field and direction for the list of reference tables. Use field name for ascending, prefix with "-" for descending.
         :type sort: ReferenceTableSortType, optional
         :param filter_status: Filter by table status.
         :type filter_status: str, optional
@@ -373,7 +378,7 @@ def update_reference_table(
 
         Update a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type `source:LOCAL_FILE`, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with `source:` types of `S3 ``,`` GCS ``, or`` AZURE`, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage.
 
-        :param id: The ID of the reference table to update
+        :param id: Unique identifier of the reference table to update
         :type id: str
         :type body: PatchTableRequest
         :rtype: None

src/datadog_api_client/v2/api/reference_tables_api.py

@@ -32,9 +32,9 @@ def openapi_types(_):
 
     def __init__(self_, data: Union[CreateTableRequestData, UnsetType] = unset, **kwargs):
         """
-        The definition of ``CreateTableRequest`` object.
+        Request body for creating a new reference table from a local file or cloud storage.
 
-        :param data: The definition of ``CreateTableRequestData`` object.
+        :param data: The data object containing the table definition.
         :type data: CreateTableRequestData, optional
         """
         if data is not unset:

src/datadog_api_client/v2/model/create_table_request.py

@@ -19,46 +19,42 @@
 
 
 class CreateTableRequestData(ModelNormal):
+    @cached_property
+    def additional_properties_type(_):
+        return None
+
     @cached_property
     def openapi_types(_):
         from datadog_api_client.v2.model.create_table_request_data_attributes import CreateTableRequestDataAttributes
         from datadog_api_client.v2.model.create_table_request_data_type import CreateTableRequestDataType
 
         return {
             "attributes": (CreateTableRequestDataAttributes,),
-            "id": (str,),
             "type": (CreateTableRequestDataType,),
         }
 
     attribute_map = {
         "attributes": "attributes",
-        "id": "id",
         "type": "type",
     }
 
     def __init__(
         self_,
         type: CreateTableRequestDataType,
         attributes: Union[CreateTableRequestDataAttributes, UnsetType] = unset,
-        id: Union[str, UnsetType] = unset,
         **kwargs,
     ):
         """
-        The definition of ``CreateTableRequestData`` object.
+        The data object containing the table definition.
 
-        :param attributes: The definition of ``CreateTableRequestDataAttributes`` object.
+        :param attributes: Attributes that define the reference table's configuration and properties.
         :type attributes: CreateTableRequestDataAttributes, optional
 
-        :param id: The ID of the reference table.
-        :type id: str, optional
-
         :param type: Reference table resource type.
         :type type: CreateTableRequestDataType
         """
         if attributes is not unset:
             kwargs["attributes"] = attributes
-        if id is not unset:
-            kwargs["id"] = id
         super().__init__(kwargs)
 
         self_.type = type

src/datadog_api_client/v2/model/create_table_request_data.py

@@ -74,24 +74,24 @@ def __init__(
         **kwargs,
     ):
         """
-        The definition of ``CreateTableRequestDataAttributes`` object.
+        Attributes that define the reference table's configuration and properties.
 
-        :param description: The description of the reference table.
+        :param description: Optional text describing the purpose or contents of this reference table.
         :type description: str, optional
 
-        :param file_metadata: The definition of ``CreateTableRequestDataAttributesFileMetadata`` object.
+        :param file_metadata: Metadata specifying where and how to access the reference table's data file.
         :type file_metadata: CreateTableRequestDataAttributesFileMetadata, optional
 
-        :param schema: The definition of ``CreateTableRequestDataAttributesSchema`` object.
+        :param schema: Schema defining the structure and columns of the reference table.
         :type schema: CreateTableRequestDataAttributesSchema
 
         :param source: The source type for creating reference table data. Only these source types can be created through this API.
         :type source: ReferenceTableCreateSourceType
 
-        :param table_name: The name of the reference table.
+        :param table_name: Name to identify this reference table.
         :type table_name: str
 
-        :param tags: The tags of the reference table.
+        :param tags: Tags for organizing and filtering reference tables.
         :type tags: [str], optional
         """
         if description is not unset:

src/datadog_api_client/v2/model/create_table_request_data_attributes.py

@@ -13,9 +13,9 @@
 class CreateTableRequestDataAttributesFileMetadata(ModelComposed):
     def __init__(self, **kwargs):
         """
-        The definition of ``CreateTableRequestDataAttributesFileMetadata`` object.
+        Metadata specifying where and how to access the reference table's data file.
 
-        :param access_details: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.
+        :param access_details: Cloud storage access configuration for the reference table data file.
         :type access_details: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails
 
         :param sync_enabled: Whether this table is synced automatically.

src/datadog_api_client/v2/model/create_table_request_data_attributes_file_metadata.py

@@ -47,7 +47,7 @@ def __init__(
         """
         Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.
 
-        :param access_details: The definition of ``CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails`` object.
+        :param access_details: Cloud storage access configuration for the reference table data file.
         :type access_details: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails
 
         :param sync_enabled: Whether this table is synced automatically.

src/datadog_api_client/v2/model/create_table_request_data_attributes_file_metadata_cloud_storage.py

@@ -60,15 +60,15 @@ def __init__(
         **kwargs,
     ):
         """
-        The definition of ``CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails`` object.
+        Cloud storage access configuration for the reference table data file.
 
-        :param aws_detail: The definition of ``CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail`` object.
+        :param aws_detail: Amazon Web Services S3 storage access configuration.
         :type aws_detail: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail, optional
 
-        :param azure_detail: The definition of ``CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail`` object.
+        :param azure_detail: Azure Blob Storage access configuration.
         :type azure_detail: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail, optional
 
-        :param gcp_detail: The definition of ``CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail`` object.
+        :param gcp_detail: Google Cloud Platform storage access configuration.
         :type gcp_detail: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail, optional
         """
         if aws_detail is not unset:

src/datadog_api_client/v2/model/create_table_request_data_attributes_file_metadata_one_of_access_details.py

@@ -27,12 +27,12 @@ def openapi_types(_):
 
     def __init__(self_, aws_account_id: str, aws_bucket_name: str, file_path: str, **kwargs):
         """
-        The definition of ``CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail`` object.
+        Amazon Web Services S3 storage access configuration.
 
-        :param aws_account_id: The ID of the AWS account.
+        :param aws_account_id: AWS account ID where the S3 bucket is located.
         :type aws_account_id: str
 
-        :param aws_bucket_name: The name of the Amazon S3 bucket.
+        :param aws_bucket_name: S3 bucket containing the CSV file.
         :type aws_bucket_name: str
 
         :param file_path: The relative file path from the S3 bucket root to the CSV file.