From d898e44c72745ef58e649eabdaca8dbb48d94f6a Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 7 Nov 2025 21:10:19 +0000 Subject: [PATCH] Regenerate client from commit cd4cfde of spec repo --- .generator/schemas/v2/openapi.yaml | 333 ++++++++++-------- .../reference-tables/UpdateReferenceTable.ts | 1 - features/v2/reference_tables.feature | 6 +- .../apis/ReferenceTablesApi.ts | 16 +- .../models/CreateTableRequest.ts | 4 +- .../models/CreateTableRequestData.ts | 23 +- .../CreateTableRequestDataAttributes.ts | 12 +- ...eTableRequestDataAttributesFileMetadata.ts | 2 +- ...tDataAttributesFileMetadataCloudStorage.ts | 2 +- ...ttributesFileMetadataOneOfAccessDetails.ts | 8 +- ...FileMetadataOneOfAccessDetailsAwsDetail.ts | 6 +- ...leMetadataOneOfAccessDetailsAzureDetail.ts | 10 +- ...FileMetadataOneOfAccessDetailsGcpDetail.ts | 8 +- .../CreateTableRequestDataAttributesSchema.ts | 4 +- ...eRequestDataAttributesSchemaFieldsItems.ts | 2 +- .../models/CreateUploadRequest.ts | 4 +- .../models/CreateUploadRequestData.ts | 23 +- .../CreateUploadRequestDataAttributes.ts | 10 +- .../models/CreateUploadResponse.ts | 4 +- .../models/CreateUploadResponseData.ts | 17 +- .../CreateUploadResponseDataAttributes.ts | 4 +- .../models/PatchTableRequest.ts | 4 +- .../models/PatchTableRequestData.ts | 23 +- .../models/PatchTableRequestDataAttributes.ts | 10 +- ...hTableRequestDataAttributesFileMetadata.ts | 2 +- ...tDataAttributesFileMetadataCloudStorage.ts | 2 +- ...ttributesFileMetadataOneOfAccessDetails.ts | 8 +- ...FileMetadataOneOfAccessDetailsAwsDetail.ts | 6 +- ...leMetadataOneOfAccessDetailsAzureDetail.ts | 10 +- ...FileMetadataOneOfAccessDetailsGcpDetail.ts | 8 +- .../PatchTableRequestDataAttributesSchema.ts | 6 +- ...eRequestDataAttributesSchemaFieldsItems.ts | 2 +- .../models/TableResultV2.ts | 4 +- .../models/TableResultV2Array.ts | 2 +- .../models/TableResultV2Data.ts | 17 +- .../models/TableResultV2DataAttributes.ts | 16 +- ...TableResultV2DataAttributesFileMetadata.ts | 2 +- ...2DataAttributesFileMetadataCloudStorage.ts | 5 +- ...ltV2DataAttributesFileMetadataLocalFile.ts | 10 +- ...ttributesFileMetadataOneOfAccessDetails.ts | 8 +- ...FileMetadataOneOfAccessDetailsAwsDetail.ts | 6 +- ...leMetadataOneOfAccessDetailsAzureDetail.ts | 10 +- ...FileMetadataOneOfAccessDetailsGcpDetail.ts | 8 +- .../TableResultV2DataAttributesSchema.ts | 4 +- ...ResultV2DataAttributesSchemaFieldsItems.ts | 2 +- .../models/TableRowResourceArray.ts | 2 +- .../models/TableRowResourceData.ts | 17 +- .../models/TableRowResourceDataAttributes.ts | 19 +- 48 files changed, 318 insertions(+), 394 deletions(-) diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 6ed4b42368ed..eb8766d5cce3 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -13066,7 +13066,8 @@ components: x-enum-varnames: - CREATE_RULESET CreateTableRequest: - description: The definition of `CreateTableRequest` object. + description: Request body for creating a new reference table from a local file + or cloud storage. example: data: attributes: @@ -13096,23 +13097,23 @@ components: $ref: '#/components/schemas/CreateTableRequestData' type: object CreateTableRequestData: - description: The definition of `CreateTableRequestData` object. + additionalProperties: false + description: The data object containing the table definition. properties: attributes: $ref: '#/components/schemas/CreateTableRequestDataAttributes' - id: - description: The ID of the reference table. - type: string type: $ref: '#/components/schemas/CreateTableRequestDataType' required: - type type: object CreateTableRequestDataAttributes: - description: The definition of `CreateTableRequestDataAttributes` object. + description: Attributes that define the reference table's configuration and + properties. properties: description: - description: The description of the reference table. + description: Optional text describing the purpose or contents of this reference + table. type: string file_metadata: $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadata' @@ -13121,11 +13122,14 @@ components: source: $ref: '#/components/schemas/ReferenceTableCreateSourceType' table_name: - description: The name of the reference table. - example: '' + description: Name to identify this reference table. + example: table_1 type: string tags: - description: The tags of the reference table. + description: Tags for organizing and filtering reference tables. + example: + - tag_1 + - tag_2 items: type: string type: array @@ -13135,8 +13139,8 @@ components: - source type: object CreateTableRequestDataAttributesFileMetadata: - description: The definition of `CreateTableRequestDataAttributesFileMetadata` - object. + description: Metadata specifying where and how to access the reference table's + data file. oneOf: - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataLocalFile' @@ -13162,15 +13166,15 @@ components: properties: upload_id: description: The upload ID. - example: '' + example: 00000000-0000-0000-0000-000000000000 type: string required: - upload_id title: LocalFileMetadataV2 type: object CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` - object. + description: Cloud storage access configuration for the reference table data + file. properties: aws_detail: $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail' @@ -13180,15 +13184,14 @@ components: $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail' type: object CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` - object. + description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: - description: The ID of the AWS account. + description: AWS account ID where the S3 bucket is located. example: '123456789000' type: string aws_bucket_name: - description: The name of the Amazon S3 bucket. + description: S3 bucket containing the CSV file. example: example-data-bucket type: string file_path: @@ -13203,23 +13206,23 @@ components: x-oneOf-parent: - AwsDetail CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` - object. + description: Azure Blob Storage access configuration. properties: azure_client_id: - description: The Azure client ID. + description: Azure service principal (application) client ID with permissions + to read from the container. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string azure_container_name: - description: The name of the Azure container. + description: Azure Blob Storage container containing the CSV file. example: reference-data type: string azure_storage_account_name: - description: The name of the Azure storage account. + description: Azure storage account where the container is located. example: examplestorageaccount type: string azure_tenant_id: - description: The ID of the Azure tenant. + description: Azure Active Directory tenant ID. example: cccccccc-4444-5555-6666-dddddddddddd type: string file_path: @@ -13237,8 +13240,7 @@ components: x-oneOf-parent: - AzureDetail CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail: - description: The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` - object. + description: Google Cloud Platform storage access configuration. properties: file_path: description: The relative file path from the GCS bucket root to the CSV @@ -13246,15 +13248,15 @@ components: example: data/reference_tables/users.csv type: string gcp_bucket_name: - description: The name of the GCP bucket. + description: GCP bucket containing the CSV file. example: example-data-bucket type: string gcp_project_id: - description: The ID of the GCP project. + description: GCP project ID where the bucket is located. example: example-gcp-project-12345 type: string gcp_service_account_email: - description: The email of the GCP service account. + description: Service account email with read permissions for the GCS bucket. example: example-service@example-gcp-project-12345.iam.gserviceaccount.com type: string required: @@ -13266,10 +13268,10 @@ components: x-oneOf-parent: - GcpDetail CreateTableRequestDataAttributesSchema: - description: The definition of `CreateTableRequestDataAttributesSchema` object. + description: Schema defining the structure and columns of the reference table. properties: fields: - description: The `schema` `fields`. + description: The schema fields. items: $ref: '#/components/schemas/CreateTableRequestDataAttributesSchemaFieldsItems' type: array @@ -13278,7 +13280,7 @@ components: Only one primary key is supported, and it is used as an ID to retrieve rows. example: - - '' + - field_1 items: type: string type: array @@ -13287,12 +13289,11 @@ components: - primary_keys type: object CreateTableRequestDataAttributesSchemaFieldsItems: - description: The definition of `CreateTableRequestDataAttributesSchemaFieldsItems` - object. + description: A single field (column) in the reference table schema to be created. properties: name: description: The field name. - example: '' + example: field_1 type: string type: $ref: '#/components/schemas/ReferenceTableSchemaFieldType' @@ -13310,50 +13311,51 @@ components: x-enum-varnames: - REFERENCE_TABLE CreateUploadRequest: - description: The definition of `CreateUploadRequest` object. + description: Request to create an upload for a file to be ingested into a reference + table. properties: data: $ref: '#/components/schemas/CreateUploadRequestData' type: object CreateUploadRequestData: - description: The definition of `CreateUploadRequestData` object. + additionalProperties: false + description: Request data for creating an upload for a file to be ingested into + a reference table. properties: attributes: $ref: '#/components/schemas/CreateUploadRequestDataAttributes' - id: - description: The ID of the upload. - type: string type: $ref: '#/components/schemas/CreateUploadRequestDataType' required: - type type: object CreateUploadRequestDataAttributes: - description: The definition of `CreateUploadRequestDataAttributes` object. + description: Upload configuration specifying how data is uploaded by the user, + and properties of the table to associate the upload with. properties: headers: - description: The headers of the file to upload. + description: The CSV file headers that define the schema fields, provided + in the same order as the columns in the uploaded file. example: - - '' + - field_1 + - field_2 items: type: string type: array part_count: - description: The number of parts in the upload. + description: Number of parts to split the file into for multipart upload. example: 3 format: int32 maximum: 20 type: integer part_size: - description: The size of each part in the upload in bytes. For multipart - uploads (part_count > 1), all parts except the last one must be at least - 5,000,000 bytes. For single-part uploads (part_count = 1), any size is - allowed. + description: The size of each part in the upload in bytes. All parts except + the last one must be at least 5,000,000 bytes. example: 10000000 format: int64 type: integer table_name: - description: The name of the reference table. + description: Name of the table to associate with this upload. example: '' type: string required: @@ -13372,18 +13374,21 @@ components: x-enum-varnames: - UPLOAD CreateUploadResponse: - description: The definition of `CreateUploadResponse` object. + description: Information about the upload created containing the upload ID and + pre-signed URLs to PUT chunks of the CSV file to. properties: data: $ref: '#/components/schemas/CreateUploadResponseData' type: object CreateUploadResponseData: - description: The definition of `CreateUploadResponseData` object. + additionalProperties: false + description: Upload ID and attributes of the created upload. properties: attributes: $ref: '#/components/schemas/CreateUploadResponseDataAttributes' id: - description: The ID of the upload. + description: Unique identifier for this upload. Use this ID when creating + the reference table. type: string type: $ref: '#/components/schemas/CreateUploadResponseDataType' @@ -13391,10 +13396,11 @@ components: - type type: object CreateUploadResponseDataAttributes: - description: The definition of `CreateUploadResponseDataAttributes` object. + description: Pre-signed URLs for uploading parts of the file. properties: part_urls: - description: The URLs of the parts in the upload. + description: The pre-signed URLs for uploading parts. These URLs expire + after 5 minutes. items: type: string type: array @@ -38129,7 +38135,7 @@ components: $ref: '#/components/schemas/Version' type: object PatchTableRequest: - description: The definition of `PatchTableRequest` object. + description: Request body for updating an existing reference table. example: data: attributes: @@ -38152,30 +38158,30 @@ components: sync_enabled: false tags: - test_tag - id: 00000000-0000-0000-0000-000000000000 type: reference_table properties: data: $ref: '#/components/schemas/PatchTableRequestData' type: object PatchTableRequestData: - description: The definition of `PatchTableRequestData` object. + additionalProperties: false + description: The data object containing the partial table definition updates. properties: attributes: $ref: '#/components/schemas/PatchTableRequestDataAttributes' - id: - description: The ID of the reference table. - type: string type: $ref: '#/components/schemas/PatchTableRequestDataType' required: - type type: object PatchTableRequestDataAttributes: - description: The definition of `PatchTableRequestDataAttributes` object. + description: Attributes that define the updates to the reference table's configuration + and properties. properties: description: - description: The description of the reference table. + description: Optional text describing the purpose or contents of this reference + table. + example: example description type: string file_metadata: $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadata' @@ -38183,16 +38189,20 @@ components: $ref: '#/components/schemas/PatchTableRequestDataAttributesSchema' sync_enabled: description: Whether this table is synced automatically. + example: false type: boolean tags: - description: The tags of the reference table. + description: Tags for organizing and filtering reference tables. + example: + - tag_1 + - tag_2 items: type: string type: array type: object PatchTableRequestDataAttributesFileMetadata: - description: The definition of `PatchTableRequestDataAttributesFileMetadata` - object. + description: Metadata specifying where and how to access the reference table's + data file. oneOf: - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataLocalFile' @@ -38215,15 +38225,15 @@ components: properties: upload_id: description: The upload ID. - example: '' + example: 00000000-0000-0000-0000-000000000000 type: string required: - upload_id title: LocalFileMetadataV2 type: object PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` - object. + description: Cloud storage access configuration for the reference table data + file. properties: aws_detail: $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail' @@ -38233,15 +38243,14 @@ components: $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail' type: object PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` - object. + description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: - description: The ID of the AWS account. + description: AWS account ID where the S3 bucket is located. example: '123456789000' type: string aws_bucket_name: - description: The name of the AWS bucket. + description: S3 bucket containing the CSV file. example: example-data-bucket type: string file_path: @@ -38252,23 +38261,23 @@ components: x-oneOf-parent: - AwsDetail PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` - object. + description: Azure Blob Storage access configuration. properties: azure_client_id: - description: The Azure client ID. + description: Azure service principal (application) client ID with permissions + to read from the container. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string azure_container_name: - description: The name of the Azure container. + description: Azure Blob Storage container containing the CSV file. example: reference-data type: string azure_storage_account_name: - description: The name of the Azure storage account. + description: Azure storage account where the container is located. example: examplestorageaccount type: string azure_tenant_id: - description: The ID of the Azure tenant. + description: Azure Active Directory tenant ID. example: cccccccc-4444-5555-6666-dddddddddddd type: string file_path: @@ -38280,8 +38289,7 @@ components: x-oneOf-parent: - AzureDetail PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail: - description: The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` - object. + description: Google Cloud Platform storage access configuration. properties: file_path: description: The relative file path from the GCS bucket root to the CSV @@ -38289,34 +38297,35 @@ components: example: data/reference_tables/users.csv type: string gcp_bucket_name: - description: The name of the GCP bucket. + description: GCP bucket containing the CSV file. example: example-data-bucket type: string gcp_project_id: - description: The ID of the GCP project. + description: GCP project ID where the bucket is located. example: example-gcp-project-12345 type: string gcp_service_account_email: - description: The email of the GCP service account. + description: Service account email with read permissions for the GCS bucket. example: example-service@example-gcp-project-12345.iam.gserviceaccount.com type: string type: object x-oneOf-parent: - GcpDetail PatchTableRequestDataAttributesSchema: - description: The definition of `PatchTableRequestDataAttributesSchema` object. + description: Schema defining the updates to the structure and columns of the + reference table. Schema fields cannot be deleted or renamed. properties: fields: - description: The `schema` `fields`. + description: The schema fields. items: $ref: '#/components/schemas/PatchTableRequestDataAttributesSchemaFieldsItems' type: array primary_keys: description: List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve - rows. + rows. Primary keys cannot be changed after table creation. example: - - '' + - field_1 items: type: string type: array @@ -38325,12 +38334,12 @@ components: - primary_keys type: object PatchTableRequestDataAttributesSchemaFieldsItems: - description: The definition of `PatchTableRequestDataAttributesSchemaFieldsItems` - object. + description: A single field (column) in the reference table schema to be updated. + Schema fields cannot be deleted or renamed. properties: name: description: The field name. - example: '' + example: field_1 type: string type: $ref: '#/components/schemas/ReferenceTableSchemaFieldType' @@ -50806,16 +50815,21 @@ components: type: number type: object TableResultV2: - description: The definition of `TableResultV2` object. + description: A reference table resource containing its full configuration and + state. example: data: attributes: created_by: 00000000-0000-0000-0000-000000000000 description: example description file_metadata: - access_details: {} - upload_id: 00000000-0000-0000-0000-000000000000 - last_updated_by: '' + access_details: + aws_detail: + aws_account_id: '123456789000' + aws_bucket_name: my-bucket + file_path: path/to/file.csv + sync_enabled: true + last_updated_by: 00000000-0000-0000-0000-000000000000 row_count: 5 schema: fields: @@ -50825,7 +50839,7 @@ components: type: STRING primary_keys: - id - source: LOCAL_FILE + source: S3 status: DONE table_name: test_reference_table tags: @@ -50839,7 +50853,7 @@ components: $ref: '#/components/schemas/TableResultV2Data' type: object TableResultV2Array: - description: The definition of `TableResultV2Array` object. + description: List of reference tables. example: data: - attributes: @@ -50911,12 +50925,14 @@ components: - data type: object TableResultV2Data: - description: The definition of `TableResultV2Data` object. + additionalProperties: false + description: The data object containing the reference table configuration and + state. properties: attributes: $ref: '#/components/schemas/TableResultV2DataAttributes' id: - description: The ID of the reference table. + description: Unique identifier for the reference table. type: string type: $ref: '#/components/schemas/TableResultV2DataType' @@ -50924,22 +50940,28 @@ components: - type type: object TableResultV2DataAttributes: - description: The definition of `TableResultV2DataAttributes` object. + description: Attributes that define the reference table's configuration and + properties. properties: created_by: description: UUID of the user who created the reference table. + example: 00000000-0000-0000-0000-000000000000 type: string description: - description: The description of the reference table. + description: Optional text describing the purpose or contents of this reference + table. + example: example description type: string file_metadata: $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadata' last_updated_by: description: UUID of the user who last updated the reference table. + example: 00000000-0000-0000-0000-000000000000 type: string row_count: description: The number of successfully processed rows in the reference table. + example: 5 format: int64 type: integer schema: @@ -50947,23 +50969,30 @@ components: source: $ref: '#/components/schemas/ReferenceTableSourceType' status: - description: The status of the reference table. + description: The processing status of the table. + example: DONE type: string table_name: - description: The name of the reference table. + description: Unique name to identify this reference table. Used in enrichment + processors and API calls. + example: table_1 type: string tags: - description: The tags of the reference table. + description: Tags for organizing and filtering reference tables. + example: + - tag_1 + - tag_2 items: type: string type: array updated_at: - description: The timestamp of the last update to the reference table in - ISO 8601 format. + description: When the reference table was last updated, in ISO 8601 format. + example: '2000-01-01T01:00:00+00:00' type: string type: object TableResultV2DataAttributesFileMetadata: - description: The definition of `TableResultV2DataAttributesFileMetadata` object. + description: Metadata specifying where and how to access the reference table's + data file. oneOf: - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataCloudStorage' - $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataLocalFile' @@ -50984,6 +51013,8 @@ components: sync_enabled: description: Whether this table is synced automatically. type: boolean + required: + - access_details title: CloudFileMetadataV2 type: object TableResultV2DataAttributesFileMetadataCloudStorageErrorType: @@ -51012,7 +51043,9 @@ components: - OPERATION_ERROR - SYSTEM_ERROR TableResultV2DataAttributesFileMetadataLocalFile: - description: File metadata for reference tables created by upload. + description: File metadata for reference tables created by upload. Note that + upload_id is only returned in the immediate create/replace response and is + not available in subsequent GET requests. properties: error_message: description: The error message returned from the creation/update. @@ -51021,14 +51054,11 @@ components: description: The number of rows that failed to create/update. format: int64 type: integer - upload_id: - description: The upload ID that was used to create/update the table. - type: string title: LocalFileMetadataV2 type: object TableResultV2DataAttributesFileMetadataOneOfAccessDetails: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` - object. + description: Cloud storage access configuration for the reference table data + file. properties: aws_detail: $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail' @@ -51038,15 +51068,14 @@ components: $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail' type: object TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail` - object. + description: Amazon Web Services S3 storage access configuration. properties: aws_account_id: - description: The ID of the AWS account. + description: AWS account ID where the S3 bucket is located. example: '123456789000' type: string aws_bucket_name: - description: The name of the AWS bucket. + description: S3 bucket containing the CSV file. example: example-data-bucket type: string file_path: @@ -51057,23 +51086,23 @@ components: x-oneOf-parent: - AwsDetail TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail` - object. + description: Azure Blob Storage access configuration. properties: azure_client_id: - description: The Azure client ID. + description: Azure service principal (application) client ID with permissions + to read from the container. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string azure_container_name: - description: The name of the Azure container. + description: Azure Blob Storage container containing the CSV file. example: reference-data type: string azure_storage_account_name: - description: The name of the Azure storage account. + description: Azure storage account where the container is located. example: examplestorageaccount type: string azure_tenant_id: - description: The ID of the Azure tenant. + description: Azure Active Directory tenant ID. example: cccccccc-4444-5555-6666-dddddddddddd type: string file_path: @@ -51085,8 +51114,7 @@ components: x-oneOf-parent: - AzureDetail TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail: - description: The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` - object. + description: Google Cloud Platform storage access configuration. properties: file_path: description: The relative file path from the GCS bucket root to the CSV @@ -51094,25 +51122,25 @@ components: example: data/reference_tables/users.csv type: string gcp_bucket_name: - description: The name of the GCP bucket. + description: GCP bucket containing the CSV file. example: example-data-bucket type: string gcp_project_id: - description: The ID of the GCP project. + description: GCP project ID where the bucket is located. example: example-gcp-project-12345 type: string gcp_service_account_email: - description: The email of the GCP service account. + description: Service account email with read permissions for the GCS bucket. example: example-service@example-gcp-project-12345.iam.gserviceaccount.com type: string type: object x-oneOf-parent: - GcpDetail TableResultV2DataAttributesSchema: - description: The definition of `TableResultV2DataAttributesSchema` object. + description: Schema defining the structure and columns of the reference table. properties: fields: - description: The `schema` `fields`. + description: The schema fields. items: $ref: '#/components/schemas/TableResultV2DataAttributesSchemaFieldsItems' type: array @@ -51121,7 +51149,7 @@ components: Only one primary key is supported, and it is used as an ID to retrieve rows. example: - - '' + - field_1 items: type: string type: array @@ -51130,12 +51158,11 @@ components: - primary_keys type: object TableResultV2DataAttributesSchemaFieldsItems: - description: The definition of `TableResultV2DataAttributesSchemaFieldsItems` - object. + description: A single field (column) in the reference table schema to be returned. properties: name: description: The field name. - example: '' + example: field_1 type: string type: $ref: '#/components/schemas/ReferenceTableSchemaFieldType' @@ -51153,7 +51180,7 @@ components: x-enum-varnames: - REFERENCE_TABLE TableRowResourceArray: - description: The definition of `TableRowResourceArray` object. + description: List of rows from a reference table query. properties: data: description: The rows. @@ -51164,12 +51191,13 @@ components: - data type: object TableRowResourceData: - description: The definition of `TableRowResourceData` object. + additionalProperties: false + description: The data object containing the row column names and values. properties: attributes: $ref: '#/components/schemas/TableRowResourceDataAttributes' id: - description: The ID of the row. + description: Row identifier, corresponding to the primary key value. type: string type: $ref: '#/components/schemas/TableRowResourceDataType' @@ -51177,11 +51205,12 @@ components: - type type: object TableRowResourceDataAttributes: - description: The definition of `TableRowResourceDataAttributes` object. + additionalProperties: false + description: Column values for this row in the reference table. properties: values: - additionalProperties: {} - description: The values of the row. + description: Key-value pairs representing the row data, where keys are field + names from the schema. type: object type: object TableRowResourceDataType: @@ -73141,8 +73170,8 @@ paths: format: int64 minimum: 0 type: integer - - description: Sort field and direction. Use field name for ascending, prefix - with "-" for descending. + - description: Sort field and direction for the list of reference tables. Use + field name for ascending, prefix with "-" for descending. example: -updated_at in: query name: sort @@ -73189,12 +73218,12 @@ paths: tags: - Reference Tables post: - description: '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).' + description: "Creates a reference table. You can provide data in two ways:\n1. + Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the + CSV data\n (not the file itself) in chunks to each URL in the request body. + Finally, call this\n POST endpoint with `upload_id` in `file_metadata`.\n2. + Provide `access_details` in `file_metadata` pointing to a CSV file in cloud + storage." operationId: CreateReferenceTable requestBody: content: @@ -73227,7 +73256,7 @@ paths: description: Delete a reference table by ID operationId: DeleteTable parameters: - - description: The ID of the reference table to delete + - description: Unique identifier of the reference table to delete in: path name: id required: true @@ -73253,7 +73282,7 @@ paths: description: Get a reference table by ID operationId: GetTable parameters: - - description: The ID of the reference table to retrieve + - description: Unique identifier of the reference table to retrieve in: path name: id required: true @@ -73290,7 +73319,7 @@ paths: pointing to a CSV file in the same type of cloud storage.' operationId: UpdateReferenceTable parameters: - - description: The ID of the reference table to update + - description: Unique identifier of the reference table to update in: path name: id required: true @@ -73323,7 +73352,7 @@ paths: description: Get reference table rows by their primary key values. operationId: GetRowsByID parameters: - - description: The ID of the reference table + - description: Unique identifier of the reference table to get rows from example: table-123 in: path name: id diff --git a/examples/v2/reference-tables/UpdateReferenceTable.ts b/examples/v2/reference-tables/UpdateReferenceTable.ts index b4c8125026d9..0080307154eb 100644 --- a/examples/v2/reference-tables/UpdateReferenceTable.ts +++ b/examples/v2/reference-tables/UpdateReferenceTable.ts @@ -38,7 +38,6 @@ const params: v2.ReferenceTablesApiUpdateReferenceTableRequest = { syncEnabled: false, tags: ["test_tag"], }, - id: "00000000-0000-0000-0000-000000000000", type: "reference_table", }, }, diff --git a/features/v2/reference_tables.feature b/features/v2/reference_tables.feature index 8a01298dc594..6d4bc4b97f58 100644 --- a/features/v2/reference_tables.feature +++ b/features/v2/reference_tables.feature @@ -24,7 +24,7 @@ Feature: Reference Tables @generated @skip @team:DataDog/redapl-experiences Scenario: Create reference table upload returns "Bad Request" response Given new "CreateReferenceTableUpload" request - And body with value {"data": {"attributes": {"headers": [""], "part_count": 3, "part_size": 10000000, "table_name": ""}, "type": "upload"}} + And body with value {"data": {"attributes": {"headers": ["field_1", "field_2"], "part_count": 3, "part_size": 10000000, "table_name": ""}, "type": "upload"}} When the request is sent Then the response status is 400 Bad Request @@ -108,7 +108,7 @@ Feature: Reference Tables Scenario: Update reference table returns "Bad Request" response Given new "UpdateReferenceTable" request And request contains "id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table"}} + And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "type": "reference_table"}} When the request is sent Then the response status is 400 Bad Request @@ -116,6 +116,6 @@ Feature: Reference Tables Scenario: Update reference table returns "OK" response Given new "UpdateReferenceTable" request And request contains "id" parameter from "REPLACE.ME" - And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table"}} + And body with value {"data": {"attributes": {"description": "this is a cloud table generated via a cloud bucket sync", "file_metadata": {"access_details": {"aws_detail": {"aws_account_id": "test-account-id", "aws_bucket_name": "test-bucket", "file_path": "test_rt.csv"}}, "sync_enabled": true}, "schema": {"fields": [{"name": "id", "type": "INT32"}, {"name": "name", "type": "STRING"}], "primary_keys": ["id"]}, "sync_enabled": false, "tags": ["test_tag"]}, "type": "reference_table"}} When the request is sent Then the response status is 200 OK diff --git a/packages/datadog-api-client-v2/apis/ReferenceTablesApi.ts b/packages/datadog-api-client-v2/apis/ReferenceTablesApi.ts index c0b75284ceb6..3118804a13d9 100644 --- a/packages/datadog-api-client-v2/apis/ReferenceTablesApi.ts +++ b/packages/datadog-api-client-v2/apis/ReferenceTablesApi.ts @@ -779,7 +779,7 @@ export interface ReferenceTablesApiCreateReferenceTableUploadRequest { export interface ReferenceTablesApiDeleteTableRequest { /** - * The ID of the reference table to delete + * Unique identifier of the reference table to delete * @type string */ id: string; @@ -787,7 +787,7 @@ export interface ReferenceTablesApiDeleteTableRequest { export interface ReferenceTablesApiGetRowsByIDRequest { /** - * The ID of the reference table + * Unique identifier of the reference table to get rows from * @type string */ id: string; @@ -800,7 +800,7 @@ export interface ReferenceTablesApiGetRowsByIDRequest { export interface ReferenceTablesApiGetTableRequest { /** - * The ID of the reference table to retrieve + * Unique identifier of the reference table to retrieve * @type string */ id: string; @@ -818,7 +818,7 @@ export interface ReferenceTablesApiListTablesRequest { */ pageOffset?: number; /** - * Sort field and direction. Use field name for ascending, prefix with "-" for descending. + * Sort field and direction for the list of reference tables. Use field name for ascending, prefix with "-" for descending. * @type ReferenceTableSortType */ sort?: ReferenceTableSortType; @@ -841,7 +841,7 @@ export interface ReferenceTablesApiListTablesRequest { export interface ReferenceTablesApiUpdateReferenceTableRequest { /** - * The ID of the reference table to update + * Unique identifier of the reference table to update * @type string */ id: string; @@ -869,7 +869,11 @@ export class ReferenceTablesApi { } /** - * 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: + * 1. 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`. + * 2. Provide `access_details` in `file_metadata` pointing to a CSV file in cloud storage. * @param param The request object */ public createReferenceTable( diff --git a/packages/datadog-api-client-v2/models/CreateTableRequest.ts b/packages/datadog-api-client-v2/models/CreateTableRequest.ts index 331e7480ef00..727e64d1c4ae 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequest.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequest.ts @@ -8,11 +8,11 @@ import { CreateTableRequestData } from "./CreateTableRequestData"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequest` object. + * Request body for creating a new reference table from a local file or cloud storage. */ export class CreateTableRequest { /** - * The definition of `CreateTableRequestData` object. + * The data object containing the table definition. */ "data"?: CreateTableRequestData; diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestData.ts b/packages/datadog-api-client-v2/models/CreateTableRequestData.ts index 0c380800677e..b72a0c5887b3 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestData.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestData.ts @@ -9,29 +9,18 @@ import { CreateTableRequestDataType } from "./CreateTableRequestDataType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestData` object. + * The data object containing the table definition. */ export class CreateTableRequestData { /** - * The definition of `CreateTableRequestDataAttributes` object. + * Attributes that define the reference table's configuration and properties. */ "attributes"?: CreateTableRequestDataAttributes; - /** - * The ID of the reference table. - */ - "id"?: string; /** * Reference table resource type. */ "type": CreateTableRequestDataType; - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; - /** * @ignore */ @@ -45,19 +34,11 @@ export class CreateTableRequestData { baseName: "attributes", type: "CreateTableRequestDataAttributes", }, - id: { - baseName: "id", - type: "string", - }, type: { baseName: "type", type: "CreateTableRequestDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributes.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributes.ts index 9e8243a08925..9b46c85a6f3f 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributes.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributes.ts @@ -10,19 +10,19 @@ import { ReferenceTableCreateSourceType } from "./ReferenceTableCreateSourceType import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributes` object. + * Attributes that define the reference table's configuration and properties. */ export class CreateTableRequestDataAttributes { /** - * The description of the reference table. + * Optional text describing the purpose or contents of this reference table. */ "description"?: string; /** - * The definition of `CreateTableRequestDataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ "fileMetadata"?: CreateTableRequestDataAttributesFileMetadata; /** - * The definition of `CreateTableRequestDataAttributesSchema` object. + * Schema defining the structure and columns of the reference table. */ "schema": CreateTableRequestDataAttributesSchema; /** @@ -30,11 +30,11 @@ export class CreateTableRequestDataAttributes { */ "source": ReferenceTableCreateSourceType; /** - * The name of the reference table. + * Name to identify this reference table. */ "tableName": string; /** - * The tags of the reference table. + * Tags for organizing and filtering reference tables. */ "tags"?: Array; diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadata.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadata.ts index 35dbbcec8476..c4f35634e452 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadata.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadata.ts @@ -9,7 +9,7 @@ import { CreateTableRequestDataAttributesFileMetadataLocalFile } from "./CreateT import { UnparsedObject } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ export type CreateTableRequestDataAttributesFileMetadata = diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts index 4c807b74b4c2..222b79d580f1 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts @@ -12,7 +12,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; */ export class CreateTableRequestDataAttributesFileMetadataCloudStorage { /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ "accessDetails": CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails; /** diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts index ddd7f25475c7..24088e9fbce1 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts @@ -10,19 +10,19 @@ import { CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ export class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails { /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + * Amazon Web Services S3 storage access configuration. */ "awsDetail"?: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + * Azure Blob Storage access configuration. */ "azureDetail"?: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ "gcpDetail"?: CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail; diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts index a69a28b1d1a2..f97a3f090c2f 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts @@ -7,15 +7,15 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + * Amazon Web Services S3 storage access configuration. */ export class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail { /** - * The ID of the AWS account. + * AWS account ID where the S3 bucket is located. */ "awsAccountId": string; /** - * The name of the Amazon S3 bucket. + * S3 bucket containing the CSV file. */ "awsBucketName": string; /** diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts index 97e5260ec845..3cb9717f6d32 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts @@ -7,23 +7,23 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + * Azure Blob Storage access configuration. */ export class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail { /** - * The Azure client ID. + * Azure service principal (application) client ID with permissions to read from the container. */ "azureClientId": string; /** - * The name of the Azure container. + * Azure Blob Storage container containing the CSV file. */ "azureContainerName": string; /** - * The name of the Azure storage account. + * Azure storage account where the container is located. */ "azureStorageAccountName": string; /** - * The ID of the Azure tenant. + * Azure Active Directory tenant ID. */ "azureTenantId": string; /** diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts index 232ccf568097..f90f722f4932 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts @@ -7,7 +7,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ export class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail { /** @@ -15,15 +15,15 @@ export class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDe */ "filePath": string; /** - * The name of the GCP bucket. + * GCP bucket containing the CSV file. */ "gcpBucketName": string; /** - * The ID of the GCP project. + * GCP project ID where the bucket is located. */ "gcpProjectId": string; /** - * The email of the GCP service account. + * Service account email with read permissions for the GCS bucket. */ "gcpServiceAccountEmail": string; diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchema.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchema.ts index 7150e7f235bc..565d83a0b00d 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchema.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchema.ts @@ -8,11 +8,11 @@ import { CreateTableRequestDataAttributesSchemaFieldsItems } from "./CreateTable import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesSchema` object. + * Schema defining the structure and columns of the reference table. */ export class CreateTableRequestDataAttributesSchema { /** - * The `schema` `fields`. + * The schema fields. */ "fields": Array; /** diff --git a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts index 4368e828c24d..9d0f2ddc3bcb 100644 --- a/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts +++ b/packages/datadog-api-client-v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts @@ -8,7 +8,7 @@ import { ReferenceTableSchemaFieldType } from "./ReferenceTableSchemaFieldType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateTableRequestDataAttributesSchemaFieldsItems` object. + * A single field (column) in the reference table schema to be created. */ export class CreateTableRequestDataAttributesSchemaFieldsItems { /** diff --git a/packages/datadog-api-client-v2/models/CreateUploadRequest.ts b/packages/datadog-api-client-v2/models/CreateUploadRequest.ts index 5fc630f6dd88..3ba066d2136c 100644 --- a/packages/datadog-api-client-v2/models/CreateUploadRequest.ts +++ b/packages/datadog-api-client-v2/models/CreateUploadRequest.ts @@ -8,11 +8,11 @@ import { CreateUploadRequestData } from "./CreateUploadRequestData"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateUploadRequest` object. + * Request to create an upload for a file to be ingested into a reference table. */ export class CreateUploadRequest { /** - * The definition of `CreateUploadRequestData` object. + * Request data for creating an upload for a file to be ingested into a reference table. */ "data"?: CreateUploadRequestData; diff --git a/packages/datadog-api-client-v2/models/CreateUploadRequestData.ts b/packages/datadog-api-client-v2/models/CreateUploadRequestData.ts index 0eb7a9dde258..5aa191b2d242 100644 --- a/packages/datadog-api-client-v2/models/CreateUploadRequestData.ts +++ b/packages/datadog-api-client-v2/models/CreateUploadRequestData.ts @@ -9,29 +9,18 @@ import { CreateUploadRequestDataType } from "./CreateUploadRequestDataType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateUploadRequestData` object. + * Request data for creating an upload for a file to be ingested into a reference table. */ export class CreateUploadRequestData { /** - * The definition of `CreateUploadRequestDataAttributes` object. + * Upload configuration specifying how data is uploaded by the user, and properties of the table to associate the upload with. */ "attributes"?: CreateUploadRequestDataAttributes; - /** - * The ID of the upload. - */ - "id"?: string; /** * Upload resource type. */ "type": CreateUploadRequestDataType; - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; - /** * @ignore */ @@ -45,19 +34,11 @@ export class CreateUploadRequestData { baseName: "attributes", type: "CreateUploadRequestDataAttributes", }, - id: { - baseName: "id", - type: "string", - }, type: { baseName: "type", type: "CreateUploadRequestDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/packages/datadog-api-client-v2/models/CreateUploadRequestDataAttributes.ts b/packages/datadog-api-client-v2/models/CreateUploadRequestDataAttributes.ts index b3ffd9ea35ab..2bcd353ef7b7 100644 --- a/packages/datadog-api-client-v2/models/CreateUploadRequestDataAttributes.ts +++ b/packages/datadog-api-client-v2/models/CreateUploadRequestDataAttributes.ts @@ -7,23 +7,23 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateUploadRequestDataAttributes` object. + * Upload configuration specifying how data is uploaded by the user, and properties of the table to associate the upload with. */ export class CreateUploadRequestDataAttributes { /** - * The headers of the file to upload. + * The CSV file headers that define the schema fields, provided in the same order as the columns in the uploaded file. */ "headers": Array; /** - * The number of parts in the upload. + * Number of parts to split the file into for multipart upload. */ "partCount": number; /** - * The size of each part in the upload in bytes. For multipart uploads (part_count > 1), all parts except the last one must be at least 5,000,000 bytes. For single-part uploads (part_count = 1), any size is allowed. + * The size of each part in the upload in bytes. All parts except the last one must be at least 5,000,000 bytes. */ "partSize": number; /** - * The name of the reference table. + * Name of the table to associate with this upload. */ "tableName": string; diff --git a/packages/datadog-api-client-v2/models/CreateUploadResponse.ts b/packages/datadog-api-client-v2/models/CreateUploadResponse.ts index a2fd87cf80c9..b465d5e7e49d 100644 --- a/packages/datadog-api-client-v2/models/CreateUploadResponse.ts +++ b/packages/datadog-api-client-v2/models/CreateUploadResponse.ts @@ -8,11 +8,11 @@ import { CreateUploadResponseData } from "./CreateUploadResponseData"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateUploadResponse` object. + * Information about the upload created containing the upload ID and pre-signed URLs to PUT chunks of the CSV file to. */ export class CreateUploadResponse { /** - * The definition of `CreateUploadResponseData` object. + * Upload ID and attributes of the created upload. */ "data"?: CreateUploadResponseData; diff --git a/packages/datadog-api-client-v2/models/CreateUploadResponseData.ts b/packages/datadog-api-client-v2/models/CreateUploadResponseData.ts index a001632d36df..d777101a7805 100644 --- a/packages/datadog-api-client-v2/models/CreateUploadResponseData.ts +++ b/packages/datadog-api-client-v2/models/CreateUploadResponseData.ts @@ -9,15 +9,15 @@ import { CreateUploadResponseDataType } from "./CreateUploadResponseDataType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateUploadResponseData` object. + * Upload ID and attributes of the created upload. */ export class CreateUploadResponseData { /** - * The definition of `CreateUploadResponseDataAttributes` object. + * Pre-signed URLs for uploading parts of the file. */ "attributes"?: CreateUploadResponseDataAttributes; /** - * The ID of the upload. + * Unique identifier for this upload. Use this ID when creating the reference table. */ "id"?: string; /** @@ -25,13 +25,6 @@ export class CreateUploadResponseData { */ "type": CreateUploadResponseDataType; - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; - /** * @ignore */ @@ -54,10 +47,6 @@ export class CreateUploadResponseData { type: "CreateUploadResponseDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/packages/datadog-api-client-v2/models/CreateUploadResponseDataAttributes.ts b/packages/datadog-api-client-v2/models/CreateUploadResponseDataAttributes.ts index 8852e4c4f2b7..84124fc18752 100644 --- a/packages/datadog-api-client-v2/models/CreateUploadResponseDataAttributes.ts +++ b/packages/datadog-api-client-v2/models/CreateUploadResponseDataAttributes.ts @@ -7,11 +7,11 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `CreateUploadResponseDataAttributes` object. + * Pre-signed URLs for uploading parts of the file. */ export class CreateUploadResponseDataAttributes { /** - * The URLs of the parts in the upload. + * The pre-signed URLs for uploading parts. These URLs expire after 5 minutes. */ "partUrls"?: Array; diff --git a/packages/datadog-api-client-v2/models/PatchTableRequest.ts b/packages/datadog-api-client-v2/models/PatchTableRequest.ts index 2073dc1141f9..2c7716b83ff8 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequest.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequest.ts @@ -8,11 +8,11 @@ import { PatchTableRequestData } from "./PatchTableRequestData"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequest` object. + * Request body for updating an existing reference table. */ export class PatchTableRequest { /** - * The definition of `PatchTableRequestData` object. + * The data object containing the partial table definition updates. */ "data"?: PatchTableRequestData; diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestData.ts b/packages/datadog-api-client-v2/models/PatchTableRequestData.ts index 0eeb9489524c..f4f4f72309e2 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestData.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestData.ts @@ -9,29 +9,18 @@ import { PatchTableRequestDataType } from "./PatchTableRequestDataType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestData` object. + * The data object containing the partial table definition updates. */ export class PatchTableRequestData { /** - * The definition of `PatchTableRequestDataAttributes` object. + * Attributes that define the updates to the reference table's configuration and properties. */ "attributes"?: PatchTableRequestDataAttributes; - /** - * The ID of the reference table. - */ - "id"?: string; /** * Reference table resource type. */ "type": PatchTableRequestDataType; - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; - /** * @ignore */ @@ -45,19 +34,11 @@ export class PatchTableRequestData { baseName: "attributes", type: "PatchTableRequestDataAttributes", }, - id: { - baseName: "id", - type: "string", - }, type: { baseName: "type", type: "PatchTableRequestDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributes.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributes.ts index 68e47b1b99dc..a6699da24562 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributes.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributes.ts @@ -9,19 +9,19 @@ import { PatchTableRequestDataAttributesSchema } from "./PatchTableRequestDataAt import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributes` object. + * Attributes that define the updates to the reference table's configuration and properties. */ export class PatchTableRequestDataAttributes { /** - * The description of the reference table. + * Optional text describing the purpose or contents of this reference table. */ "description"?: string; /** - * The definition of `PatchTableRequestDataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ "fileMetadata"?: PatchTableRequestDataAttributesFileMetadata; /** - * The definition of `PatchTableRequestDataAttributesSchema` object. + * Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed. */ "schema"?: PatchTableRequestDataAttributesSchema; /** @@ -29,7 +29,7 @@ export class PatchTableRequestDataAttributes { */ "syncEnabled"?: boolean; /** - * The tags of the reference table. + * Tags for organizing and filtering reference tables. */ "tags"?: Array; diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadata.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadata.ts index 07876feeb66c..e8a6d1584c50 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadata.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadata.ts @@ -9,7 +9,7 @@ import { PatchTableRequestDataAttributesFileMetadataLocalFile } from "./PatchTab import { UnparsedObject } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ export type PatchTableRequestDataAttributesFileMetadata = diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts index a853d2c37fd1..ea634513a448 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts @@ -12,7 +12,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; */ export class PatchTableRequestDataAttributesFileMetadataCloudStorage { /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ "accessDetails"?: PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails; /** diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts index dbaabe0afe11..ad6dc45722ef 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts @@ -10,19 +10,19 @@ import { PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ export class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails { /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + * Amazon Web Services S3 storage access configuration. */ "awsDetail"?: PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + * Azure Blob Storage access configuration. */ "azureDetail"?: PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ "gcpDetail"?: PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail; diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts index b7ba622569fa..cf3a80345d1f 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts @@ -7,15 +7,15 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + * Amazon Web Services S3 storage access configuration. */ export class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail { /** - * The ID of the AWS account. + * AWS account ID where the S3 bucket is located. */ "awsAccountId"?: string; /** - * The name of the AWS bucket. + * S3 bucket containing the CSV file. */ "awsBucketName"?: string; /** diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts index da9df248d321..46cb87157880 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts @@ -7,23 +7,23 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + * Azure Blob Storage access configuration. */ export class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail { /** - * The Azure client ID. + * Azure service principal (application) client ID with permissions to read from the container. */ "azureClientId"?: string; /** - * The name of the Azure container. + * Azure Blob Storage container containing the CSV file. */ "azureContainerName"?: string; /** - * The name of the Azure storage account. + * Azure storage account where the container is located. */ "azureStorageAccountName"?: string; /** - * The ID of the Azure tenant. + * Azure Active Directory tenant ID. */ "azureTenantId"?: string; /** diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts index 4e3ec1a95789..fdd3adab741b 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts @@ -7,7 +7,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ export class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail { /** @@ -15,15 +15,15 @@ export class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDet */ "filePath"?: string; /** - * The name of the GCP bucket. + * GCP bucket containing the CSV file. */ "gcpBucketName"?: string; /** - * The ID of the GCP project. + * GCP project ID where the bucket is located. */ "gcpProjectId"?: string; /** - * The email of the GCP service account. + * Service account email with read permissions for the GCS bucket. */ "gcpServiceAccountEmail"?: string; diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchema.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchema.ts index cf7b77b85fb0..a884bf38c6ac 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchema.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchema.ts @@ -8,15 +8,15 @@ import { PatchTableRequestDataAttributesSchemaFieldsItems } from "./PatchTableRe import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesSchema` object. + * Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed. */ export class PatchTableRequestDataAttributesSchema { /** - * The `schema` `fields`. + * The schema fields. */ "fields": Array; /** - * List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. + * List of field names that serve as primary keys for the table. Only one primary key is supported, and it is used as an ID to retrieve rows. Primary keys cannot be changed after table creation. */ "primaryKeys": Array; diff --git a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts index efb623c5d414..75fedf8c28bc 100644 --- a/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts +++ b/packages/datadog-api-client-v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts @@ -8,7 +8,7 @@ import { ReferenceTableSchemaFieldType } from "./ReferenceTableSchemaFieldType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `PatchTableRequestDataAttributesSchemaFieldsItems` object. + * A single field (column) in the reference table schema to be updated. Schema fields cannot be deleted or renamed. */ export class PatchTableRequestDataAttributesSchemaFieldsItems { /** diff --git a/packages/datadog-api-client-v2/models/TableResultV2.ts b/packages/datadog-api-client-v2/models/TableResultV2.ts index 0d5b196fd1d6..bc6cf8e41544 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2.ts @@ -8,11 +8,11 @@ import { TableResultV2Data } from "./TableResultV2Data"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2` object. + * A reference table resource containing its full configuration and state. */ export class TableResultV2 { /** - * The definition of `TableResultV2Data` object. + * The data object containing the reference table configuration and state. */ "data"?: TableResultV2Data; diff --git a/packages/datadog-api-client-v2/models/TableResultV2Array.ts b/packages/datadog-api-client-v2/models/TableResultV2Array.ts index abf5ee0f96ce..0821ded7259f 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2Array.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2Array.ts @@ -8,7 +8,7 @@ import { TableResultV2Data } from "./TableResultV2Data"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2Array` object. + * List of reference tables. */ export class TableResultV2Array { /** diff --git a/packages/datadog-api-client-v2/models/TableResultV2Data.ts b/packages/datadog-api-client-v2/models/TableResultV2Data.ts index 5713040746be..7d3ce99c4cb2 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2Data.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2Data.ts @@ -9,15 +9,15 @@ import { TableResultV2DataType } from "./TableResultV2DataType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2Data` object. + * The data object containing the reference table configuration and state. */ export class TableResultV2Data { /** - * The definition of `TableResultV2DataAttributes` object. + * Attributes that define the reference table's configuration and properties. */ "attributes"?: TableResultV2DataAttributes; /** - * The ID of the reference table. + * Unique identifier for the reference table. */ "id"?: string; /** @@ -25,13 +25,6 @@ export class TableResultV2Data { */ "type": TableResultV2DataType; - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; - /** * @ignore */ @@ -54,10 +47,6 @@ export class TableResultV2Data { type: "TableResultV2DataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributes.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributes.ts index 65291db41997..cdb1e23144e7 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributes.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributes.ts @@ -10,7 +10,7 @@ import { TableResultV2DataAttributesSchema } from "./TableResultV2DataAttributes import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributes` object. + * Attributes that define the reference table's configuration and properties. */ export class TableResultV2DataAttributes { /** @@ -18,11 +18,11 @@ export class TableResultV2DataAttributes { */ "createdBy"?: string; /** - * The description of the reference table. + * Optional text describing the purpose or contents of this reference table. */ "description"?: string; /** - * The definition of `TableResultV2DataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ "fileMetadata"?: TableResultV2DataAttributesFileMetadata; /** @@ -34,7 +34,7 @@ export class TableResultV2DataAttributes { */ "rowCount"?: number; /** - * The definition of `TableResultV2DataAttributesSchema` object. + * Schema defining the structure and columns of the reference table. */ "schema"?: TableResultV2DataAttributesSchema; /** @@ -42,19 +42,19 @@ export class TableResultV2DataAttributes { */ "source"?: ReferenceTableSourceType; /** - * The status of the reference table. + * The processing status of the table. */ "status"?: string; /** - * The name of the reference table. + * Unique name to identify this reference table. Used in enrichment processors and API calls. */ "tableName"?: string; /** - * The tags of the reference table. + * Tags for organizing and filtering reference tables. */ "tags"?: Array; /** - * The timestamp of the last update to the reference table in ISO 8601 format. + * When the reference table was last updated, in ISO 8601 format. */ "updatedAt"?: string; diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadata.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadata.ts index 68d6802074b9..0541e777eef0 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadata.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadata.ts @@ -9,7 +9,7 @@ import { TableResultV2DataAttributesFileMetadataLocalFile } from "./TableResultV import { UnparsedObject } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ export type TableResultV2DataAttributesFileMetadata = diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts index 9fc3e13dee5b..e505c85ad7c7 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts @@ -13,9 +13,9 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; */ export class TableResultV2DataAttributesFileMetadataCloudStorage { /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ - "accessDetails"?: TableResultV2DataAttributesFileMetadataOneOfAccessDetails; + "accessDetails": TableResultV2DataAttributesFileMetadataOneOfAccessDetails; /** * The error message returned from the sync. */ @@ -52,6 +52,7 @@ export class TableResultV2DataAttributesFileMetadataCloudStorage { accessDetails: { baseName: "access_details", type: "TableResultV2DataAttributesFileMetadataOneOfAccessDetails", + required: true, }, errorMessage: { baseName: "error_message", diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts index 1a7ac13c4faa..5af8d26fd421 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts @@ -7,7 +7,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * File metadata for reference tables created by upload. + * File metadata for reference tables created by upload. Note that upload_id is only returned in the immediate create/replace response and is not available in subsequent GET requests. */ export class TableResultV2DataAttributesFileMetadataLocalFile { /** @@ -18,10 +18,6 @@ export class TableResultV2DataAttributesFileMetadataLocalFile { * The number of rows that failed to create/update. */ "errorRowCount"?: number; - /** - * The upload ID that was used to create/update the table. - */ - "uploadId"?: string; /** * A container for additional, undeclared properties. @@ -48,10 +44,6 @@ export class TableResultV2DataAttributesFileMetadataLocalFile { type: "number", format: "int64", }, - uploadId: { - baseName: "upload_id", - type: "string", - }, additionalProperties: { baseName: "additionalProperties", type: "{ [key: string]: any; }", diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts index e0bdd6771df0..c6b7430b9efc 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts @@ -10,19 +10,19 @@ import { TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail } fr import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ export class TableResultV2DataAttributesFileMetadataOneOfAccessDetails { /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + * Amazon Web Services S3 storage access configuration. */ "awsDetail"?: TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + * Azure Blob Storage access configuration. */ "azureDetail"?: TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ "gcpDetail"?: TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail; diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts index f55ac489099e..76fb38f52f5d 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts @@ -7,15 +7,15 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object. + * Amazon Web Services S3 storage access configuration. */ export class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail { /** - * The ID of the AWS account. + * AWS account ID where the S3 bucket is located. */ "awsAccountId"?: string; /** - * The name of the AWS bucket. + * S3 bucket containing the CSV file. */ "awsBucketName"?: string; /** diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts index 13a3973a374e..af790e57fbbf 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts @@ -7,23 +7,23 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object. + * Azure Blob Storage access configuration. */ export class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail { /** - * The Azure client ID. + * Azure service principal (application) client ID with permissions to read from the container. */ "azureClientId"?: string; /** - * The name of the Azure container. + * Azure Blob Storage container containing the CSV file. */ "azureContainerName"?: string; /** - * The name of the Azure storage account. + * Azure storage account where the container is located. */ "azureStorageAccountName"?: string; /** - * The ID of the Azure tenant. + * Azure Active Directory tenant ID. */ "azureTenantId"?: string; /** diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts index 097e7f99c0d3..0d72ef1dc960 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts @@ -7,7 +7,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ export class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail { /** @@ -15,15 +15,15 @@ export class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail */ "filePath"?: string; /** - * The name of the GCP bucket. + * GCP bucket containing the CSV file. */ "gcpBucketName"?: string; /** - * The ID of the GCP project. + * GCP project ID where the bucket is located. */ "gcpProjectId"?: string; /** - * The email of the GCP service account. + * Service account email with read permissions for the GCS bucket. */ "gcpServiceAccountEmail"?: string; diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchema.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchema.ts index d3ccd71fe745..24caa73efd70 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchema.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchema.ts @@ -8,11 +8,11 @@ import { TableResultV2DataAttributesSchemaFieldsItems } from "./TableResultV2Dat import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesSchema` object. + * Schema defining the structure and columns of the reference table. */ export class TableResultV2DataAttributesSchema { /** - * The `schema` `fields`. + * The schema fields. */ "fields": Array; /** diff --git a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts index 8b5ecff76990..f8a3dea1bcc1 100644 --- a/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts +++ b/packages/datadog-api-client-v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts @@ -8,7 +8,7 @@ import { ReferenceTableSchemaFieldType } from "./ReferenceTableSchemaFieldType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableResultV2DataAttributesSchemaFieldsItems` object. + * A single field (column) in the reference table schema to be returned. */ export class TableResultV2DataAttributesSchemaFieldsItems { /** diff --git a/packages/datadog-api-client-v2/models/TableRowResourceArray.ts b/packages/datadog-api-client-v2/models/TableRowResourceArray.ts index 8bf9ef2efd52..3995c29418d2 100644 --- a/packages/datadog-api-client-v2/models/TableRowResourceArray.ts +++ b/packages/datadog-api-client-v2/models/TableRowResourceArray.ts @@ -8,7 +8,7 @@ import { TableRowResourceData } from "./TableRowResourceData"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableRowResourceArray` object. + * List of rows from a reference table query. */ export class TableRowResourceArray { /** diff --git a/packages/datadog-api-client-v2/models/TableRowResourceData.ts b/packages/datadog-api-client-v2/models/TableRowResourceData.ts index 2eacd761ae60..2a7d7a5a9358 100644 --- a/packages/datadog-api-client-v2/models/TableRowResourceData.ts +++ b/packages/datadog-api-client-v2/models/TableRowResourceData.ts @@ -9,15 +9,15 @@ import { TableRowResourceDataType } from "./TableRowResourceDataType"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableRowResourceData` object. + * The data object containing the row column names and values. */ export class TableRowResourceData { /** - * The definition of `TableRowResourceDataAttributes` object. + * Column values for this row in the reference table. */ "attributes"?: TableRowResourceDataAttributes; /** - * The ID of the row. + * Row identifier, corresponding to the primary key value. */ "id"?: string; /** @@ -25,13 +25,6 @@ export class TableRowResourceData { */ "type": TableRowResourceDataType; - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; - /** * @ignore */ @@ -54,10 +47,6 @@ export class TableRowResourceData { type: "TableRowResourceDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/packages/datadog-api-client-v2/models/TableRowResourceDataAttributes.ts b/packages/datadog-api-client-v2/models/TableRowResourceDataAttributes.ts index 7d81d07400ce..d362cab071f9 100644 --- a/packages/datadog-api-client-v2/models/TableRowResourceDataAttributes.ts +++ b/packages/datadog-api-client-v2/models/TableRowResourceDataAttributes.ts @@ -7,20 +7,13 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util"; /** - * The definition of `TableRowResourceDataAttributes` object. + * Column values for this row in the reference table. */ export class TableRowResourceDataAttributes { /** - * The values of the row. + * Key-value pairs representing the row data, where keys are field names from the schema. */ - "values"?: { [key: string]: any }; - - /** - * A container for additional, undeclared properties. - * This is a holder for any undeclared properties as specified with - * the 'additionalProperties' keyword in the OAS document. - */ - "additionalProperties"?: { [key: string]: any }; + "values"?: any; /** * @ignore @@ -33,11 +26,7 @@ export class TableRowResourceDataAttributes { static readonly attributeTypeMap: AttributeTypeMap = { values: { baseName: "values", - type: "{ [key: string]: any; }", - }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", + type: "any", }, };