From d521a9c01e93c5f236459380bc7cda696438e9c8 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 7 Nov 2025 21:07:49 +0000 Subject: [PATCH] Regenerate client from commit cd4cfde of spec repo --- .generator/schemas/v2/openapi.yaml | 333 ++++++++++-------- features/v2/reference_tables.feature | 6 +- .../src/v2/ReferenceTablesApi.ts | 16 +- .../src/v2/models/CreateTableRequest.ts | 4 +- .../src/v2/models/CreateTableRequestData.ts | 22 +- .../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 +- .../src/v2/models/CreateUploadRequest.ts | 4 +- .../src/v2/models/CreateUploadRequestData.ts | 22 +- .../CreateUploadRequestDataAttributes.ts | 10 +- .../src/v2/models/CreateUploadResponse.ts | 4 +- .../src/v2/models/CreateUploadResponseData.ts | 16 +- .../CreateUploadResponseDataAttributes.ts | 4 +- .../src/v2/models/PatchTableRequest.ts | 4 +- .../src/v2/models/PatchTableRequestData.ts | 22 +- .../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 +- .../src/v2/models/TableResultV2.ts | 4 +- .../src/v2/models/TableResultV2Array.ts | 2 +- .../src/v2/models/TableResultV2Data.ts | 16 +- .../v2/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 +- .../src/v2/models/TableRowResourceArray.ts | 2 +- .../src/v2/models/TableRowResourceData.ts | 16 +- .../models/TableRowResourceDataAttributes.ts | 18 +- 47 files changed, 318 insertions(+), 386 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/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/services/reference_tables/src/v2/ReferenceTablesApi.ts b/services/reference_tables/src/v2/ReferenceTablesApi.ts index 39b1826ac5bc..66ba036b5b80 100644 --- a/services/reference_tables/src/v2/ReferenceTablesApi.ts +++ b/services/reference_tables/src/v2/ReferenceTablesApi.ts @@ -847,7 +847,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; @@ -855,7 +855,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; @@ -868,7 +868,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; @@ -886,7 +886,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; @@ -909,7 +909,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; @@ -940,7 +940,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/services/reference_tables/src/v2/models/CreateTableRequest.ts b/services/reference_tables/src/v2/models/CreateTableRequest.ts index 7cd36cd73802..f303a09e4310 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequest.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequest.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateTableRequestData } from "./CreateTableRequestData"; /** - * 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/services/reference_tables/src/v2/models/CreateTableRequestData.ts b/services/reference_tables/src/v2/models/CreateTableRequestData.ts index 67a5f9ac7cc2..32aefb244b86 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestData.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestData.ts @@ -4,27 +4,17 @@ import { CreateTableRequestDataAttributes } from "./CreateTableRequestDataAttrib import { CreateTableRequestDataType } from "./CreateTableRequestDataType"; /** - * 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 */ @@ -38,19 +28,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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributes.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributes.ts index e96e2607085e..5f07f7b7f3da 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributes.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributes.ts @@ -5,19 +5,19 @@ import { CreateTableRequestDataAttributesSchema } from "./CreateTableRequestData import { ReferenceTableCreateSourceType } from "./ReferenceTableCreateSourceType"; /** - * 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; /** @@ -25,11 +25,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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadata.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadata.ts index 4afe2ac9e247..9886db14936a 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadata.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadata.ts @@ -4,7 +4,7 @@ import { CreateTableRequestDataAttributesFileMetadataCloudStorage } from "./Crea import { CreateTableRequestDataAttributesFileMetadataLocalFile } from "./CreateTableRequestDataAttributesFileMetadataLocalFile"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ export type CreateTableRequestDataAttributesFileMetadata = | CreateTableRequestDataAttributesFileMetadataCloudStorage diff --git a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts index 36502559def8..5569f3aba441 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataCloudStorage.ts @@ -7,7 +7,7 @@ import { CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails } from " */ export class CreateTableRequestDataAttributesFileMetadataCloudStorage { /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ "accessDetails": CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails; /** diff --git a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts index 9c4b098f9547..af5ff327926e 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts @@ -5,19 +5,19 @@ import { CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDeta import { CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail } from "./CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail"; /** - * 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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts index e67eaf34e98d..30cbb3142ca7 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts @@ -1,15 +1,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts index 5c2ee6c0e1ff..cd65fab5914c 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts @@ -1,23 +1,23 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts index d229e8b3e892..8e76037d781c 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ export class CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail { /** @@ -9,15 +9,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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchema.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchema.ts index 18aae2223d17..fd1b21f9ccbc 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchema.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchema.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateTableRequestDataAttributesSchemaFieldsItems } from "./CreateTableRequestDataAttributesSchemaFieldsItems"; /** - * 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/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts index 949154787c2a..4e3d3ed9d794 100644 --- a/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts +++ b/services/reference_tables/src/v2/models/CreateTableRequestDataAttributesSchemaFieldsItems.ts @@ -3,7 +3,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ReferenceTableSchemaFieldType } from "./ReferenceTableSchemaFieldType"; /** - * The definition of `CreateTableRequestDataAttributesSchemaFieldsItems` object. + * A single field (column) in the reference table schema to be created. */ export class CreateTableRequestDataAttributesSchemaFieldsItems { /** diff --git a/services/reference_tables/src/v2/models/CreateUploadRequest.ts b/services/reference_tables/src/v2/models/CreateUploadRequest.ts index 1ab18168baf0..a6991c84ba45 100644 --- a/services/reference_tables/src/v2/models/CreateUploadRequest.ts +++ b/services/reference_tables/src/v2/models/CreateUploadRequest.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateUploadRequestData } from "./CreateUploadRequestData"; /** - * 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/services/reference_tables/src/v2/models/CreateUploadRequestData.ts b/services/reference_tables/src/v2/models/CreateUploadRequestData.ts index c53f8dbf23df..d0b0a415adaa 100644 --- a/services/reference_tables/src/v2/models/CreateUploadRequestData.ts +++ b/services/reference_tables/src/v2/models/CreateUploadRequestData.ts @@ -4,27 +4,17 @@ import { CreateUploadRequestDataAttributes } from "./CreateUploadRequestDataAttr import { CreateUploadRequestDataType } from "./CreateUploadRequestDataType"; /** - * 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 */ @@ -38,19 +28,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/services/reference_tables/src/v2/models/CreateUploadRequestDataAttributes.ts b/services/reference_tables/src/v2/models/CreateUploadRequestDataAttributes.ts index 99f47985be5b..5c449123d3d2 100644 --- a/services/reference_tables/src/v2/models/CreateUploadRequestDataAttributes.ts +++ b/services/reference_tables/src/v2/models/CreateUploadRequestDataAttributes.ts @@ -1,23 +1,23 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/CreateUploadResponse.ts b/services/reference_tables/src/v2/models/CreateUploadResponse.ts index 16dbaea58615..a0c03453bb9d 100644 --- a/services/reference_tables/src/v2/models/CreateUploadResponse.ts +++ b/services/reference_tables/src/v2/models/CreateUploadResponse.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateUploadResponseData } from "./CreateUploadResponseData"; /** - * 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/services/reference_tables/src/v2/models/CreateUploadResponseData.ts b/services/reference_tables/src/v2/models/CreateUploadResponseData.ts index 7e2cc1d9cd28..606d34dd83d5 100644 --- a/services/reference_tables/src/v2/models/CreateUploadResponseData.ts +++ b/services/reference_tables/src/v2/models/CreateUploadResponseData.ts @@ -4,27 +4,21 @@ import { CreateUploadResponseDataAttributes } from "./CreateUploadResponseDataAt import { CreateUploadResponseDataType } from "./CreateUploadResponseDataType"; /** - * 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; /** * Upload resource type. */ "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 */ @@ -47,10 +41,6 @@ export class CreateUploadResponseData { type: "CreateUploadResponseDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/services/reference_tables/src/v2/models/CreateUploadResponseDataAttributes.ts b/services/reference_tables/src/v2/models/CreateUploadResponseDataAttributes.ts index f7d61ad02b67..c4c83c8e2e87 100644 --- a/services/reference_tables/src/v2/models/CreateUploadResponseDataAttributes.ts +++ b/services/reference_tables/src/v2/models/CreateUploadResponseDataAttributes.ts @@ -1,11 +1,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/PatchTableRequest.ts b/services/reference_tables/src/v2/models/PatchTableRequest.ts index 6450104b741d..0faa0c66f006 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequest.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequest.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchTableRequestData } from "./PatchTableRequestData"; /** - * 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/services/reference_tables/src/v2/models/PatchTableRequestData.ts b/services/reference_tables/src/v2/models/PatchTableRequestData.ts index 8d4e193fd442..d15dc7f7fee8 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestData.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestData.ts @@ -4,27 +4,17 @@ import { PatchTableRequestDataAttributes } from "./PatchTableRequestDataAttribut import { PatchTableRequestDataType } from "./PatchTableRequestDataType"; /** - * 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 */ @@ -38,19 +28,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/services/reference_tables/src/v2/models/PatchTableRequestDataAttributes.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributes.ts index 6bf224cb9a37..770d74e25533 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributes.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributes.ts @@ -4,19 +4,19 @@ import { PatchTableRequestDataAttributesFileMetadata } from "./PatchTableRequest import { PatchTableRequestDataAttributesSchema } from "./PatchTableRequestDataAttributesSchema"; /** - * 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; /** @@ -24,7 +24,7 @@ export class PatchTableRequestDataAttributes { */ "syncEnabled"?: boolean; /** - * The tags of the reference table. + * Tags for organizing and filtering reference tables. */ "tags"?: Array; /** diff --git a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadata.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadata.ts index 70e2c3008f63..da23365bd33d 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadata.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadata.ts @@ -4,7 +4,7 @@ import { PatchTableRequestDataAttributesFileMetadataCloudStorage } from "./Patch import { PatchTableRequestDataAttributesFileMetadataLocalFile } from "./PatchTableRequestDataAttributesFileMetadataLocalFile"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ export type PatchTableRequestDataAttributesFileMetadata = | PatchTableRequestDataAttributesFileMetadataCloudStorage diff --git a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts index 3c6a51758a96..0af5592950fa 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataCloudStorage.ts @@ -7,7 +7,7 @@ import { PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails } from ". */ export class PatchTableRequestDataAttributesFileMetadataCloudStorage { /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object. + * Cloud storage access configuration for the reference table data file. */ "accessDetails"?: PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails; /** diff --git a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts index e7d553405739..9cf27de690c0 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails.ts @@ -5,19 +5,19 @@ import { PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetai import { PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail } from "./PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail"; /** - * 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/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts index ad39ca1d4ebf..8c1b8daa11b1 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts @@ -1,15 +1,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts index dd2d65872ca5..81b7861c7c97 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts @@ -1,23 +1,23 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts index 336086147860..a49bdfaac540 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ export class PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail { /** @@ -9,15 +9,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/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchema.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchema.ts index 7ac81c54fd58..eb037a2e46c3 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchema.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchema.ts @@ -3,15 +3,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchTableRequestDataAttributesSchemaFieldsItems } from "./PatchTableRequestDataAttributesSchemaFieldsItems"; /** - * 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/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts index 30e3877b4151..c8f15d45018c 100644 --- a/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts +++ b/services/reference_tables/src/v2/models/PatchTableRequestDataAttributesSchemaFieldsItems.ts @@ -3,7 +3,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ReferenceTableSchemaFieldType } from "./ReferenceTableSchemaFieldType"; /** - * 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/services/reference_tables/src/v2/models/TableResultV2.ts b/services/reference_tables/src/v2/models/TableResultV2.ts index 331f7fda6bba..4497d14f9392 100644 --- a/services/reference_tables/src/v2/models/TableResultV2.ts +++ b/services/reference_tables/src/v2/models/TableResultV2.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TableResultV2Data } from "./TableResultV2Data"; /** - * 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/services/reference_tables/src/v2/models/TableResultV2Array.ts b/services/reference_tables/src/v2/models/TableResultV2Array.ts index 280ac1052915..79b68a69a5a8 100644 --- a/services/reference_tables/src/v2/models/TableResultV2Array.ts +++ b/services/reference_tables/src/v2/models/TableResultV2Array.ts @@ -3,7 +3,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TableResultV2Data } from "./TableResultV2Data"; /** - * The definition of `TableResultV2Array` object. + * List of reference tables. */ export class TableResultV2Array { /** diff --git a/services/reference_tables/src/v2/models/TableResultV2Data.ts b/services/reference_tables/src/v2/models/TableResultV2Data.ts index 8aa3fa6f417a..3faa8b76ed43 100644 --- a/services/reference_tables/src/v2/models/TableResultV2Data.ts +++ b/services/reference_tables/src/v2/models/TableResultV2Data.ts @@ -4,27 +4,21 @@ import { TableResultV2DataAttributes } from "./TableResultV2DataAttributes"; import { TableResultV2DataType } from "./TableResultV2DataType"; /** - * 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; /** * Reference table resource type. */ "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 */ @@ -47,10 +41,6 @@ export class TableResultV2Data { type: "TableResultV2DataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/services/reference_tables/src/v2/models/TableResultV2DataAttributes.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributes.ts index 472302c68b0a..c4f337929612 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributes.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributes.ts @@ -5,7 +5,7 @@ import { TableResultV2DataAttributesFileMetadata } from "./TableResultV2DataAttr import { TableResultV2DataAttributesSchema } from "./TableResultV2DataAttributesSchema"; /** - * The definition of `TableResultV2DataAttributes` object. + * Attributes that define the reference table's configuration and properties. */ export class TableResultV2DataAttributes { /** @@ -13,11 +13,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; /** @@ -29,7 +29,7 @@ export class TableResultV2DataAttributes { */ "rowCount"?: number; /** - * The definition of `TableResultV2DataAttributesSchema` object. + * Schema defining the structure and columns of the reference table. */ "schema"?: TableResultV2DataAttributesSchema; /** @@ -37,19 +37,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/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadata.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadata.ts index 29331f5c07e9..1f0c9cc7ba5c 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadata.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadata.ts @@ -4,7 +4,7 @@ import { TableResultV2DataAttributesFileMetadataCloudStorage } from "./TableResu import { TableResultV2DataAttributesFileMetadataLocalFile } from "./TableResultV2DataAttributesFileMetadataLocalFile"; /** - * The definition of `TableResultV2DataAttributesFileMetadata` object. + * Metadata specifying where and how to access the reference table's data file. */ export type TableResultV2DataAttributesFileMetadata = | TableResultV2DataAttributesFileMetadataCloudStorage diff --git a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts index 8bb9b8c62d9c..b9639a185a21 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataCloudStorage.ts @@ -8,9 +8,9 @@ import { TableResultV2DataAttributesFileMetadataOneOfAccessDetails } from "./Tab */ 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. */ @@ -45,6 +45,7 @@ export class TableResultV2DataAttributesFileMetadataCloudStorage { accessDetails: { baseName: "access_details", type: "TableResultV2DataAttributesFileMetadataOneOfAccessDetails", + required: true, }, errorMessage: { baseName: "error_message", diff --git a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts index 8aab1fd69f02..02b248262477 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataLocalFile.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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 { /** @@ -12,10 +12,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. * This is a holder for any undeclared properties as specified with @@ -40,10 +36,6 @@ export class TableResultV2DataAttributesFileMetadataLocalFile { type: "number", format: "int64", }, - uploadId: { - baseName: "upload_id", - type: "string", - }, additionalProperties: { baseName: "additionalProperties", type: "{ [key: string]: any; }", diff --git a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts index 74f14d0e7065..cf7c9085e17d 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetails.ts @@ -5,19 +5,19 @@ import { TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail } import { TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail } from "./TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail"; /** - * 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/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts index 131feebf3af4..1b79be7f42a1 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail.ts @@ -1,15 +1,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts index d380cd967ea5..dea98cd6f9fb 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail.ts @@ -1,23 +1,23 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts index 87e0dde75225..ea1807fdab60 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail.ts @@ -1,7 +1,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object. + * Google Cloud Platform storage access configuration. */ export class TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail { /** @@ -9,15 +9,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/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchema.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchema.ts index 120c616f777c..a6beef57de80 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchema.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchema.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TableResultV2DataAttributesSchemaFieldsItems } from "./TableResultV2DataAttributesSchemaFieldsItems"; /** - * 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/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts b/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts index daf202357833..1f5a41a57a94 100644 --- a/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts +++ b/services/reference_tables/src/v2/models/TableResultV2DataAttributesSchemaFieldsItems.ts @@ -3,7 +3,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ReferenceTableSchemaFieldType } from "./ReferenceTableSchemaFieldType"; /** - * The definition of `TableResultV2DataAttributesSchemaFieldsItems` object. + * A single field (column) in the reference table schema to be returned. */ export class TableResultV2DataAttributesSchemaFieldsItems { /** diff --git a/services/reference_tables/src/v2/models/TableRowResourceArray.ts b/services/reference_tables/src/v2/models/TableRowResourceArray.ts index 5f1215d5ee22..f11b77293669 100644 --- a/services/reference_tables/src/v2/models/TableRowResourceArray.ts +++ b/services/reference_tables/src/v2/models/TableRowResourceArray.ts @@ -3,7 +3,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TableRowResourceData } from "./TableRowResourceData"; /** - * The definition of `TableRowResourceArray` object. + * List of rows from a reference table query. */ export class TableRowResourceArray { /** diff --git a/services/reference_tables/src/v2/models/TableRowResourceData.ts b/services/reference_tables/src/v2/models/TableRowResourceData.ts index 60ed68eccaf9..974aa55d3562 100644 --- a/services/reference_tables/src/v2/models/TableRowResourceData.ts +++ b/services/reference_tables/src/v2/models/TableRowResourceData.ts @@ -4,27 +4,21 @@ import { TableRowResourceDataAttributes } from "./TableRowResourceDataAttributes import { TableRowResourceDataType } from "./TableRowResourceDataType"; /** - * 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; /** * Row resource type. */ "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 */ @@ -47,10 +41,6 @@ export class TableRowResourceData { type: "TableRowResourceDataType", required: true, }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", - }, }; /** diff --git a/services/reference_tables/src/v2/models/TableRowResourceDataAttributes.ts b/services/reference_tables/src/v2/models/TableRowResourceDataAttributes.ts index cf4b600bd1ff..a80173c4990f 100644 --- a/services/reference_tables/src/v2/models/TableRowResourceDataAttributes.ts +++ b/services/reference_tables/src/v2/models/TableRowResourceDataAttributes.ts @@ -1,19 +1,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * 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 */ @@ -25,11 +19,7 @@ export class TableRowResourceDataAttributes { static readonly attributeTypeMap: AttributeTypeMap = { values: { baseName: "values", - type: "{ [key: string]: any; }", - }, - additionalProperties: { - baseName: "additionalProperties", - type: "{ [key: string]: any; }", + type: "any", }, };