diff --git a/content/en/api/v2/reference-tables/examples.json b/content/en/api/v2/reference-tables/examples.json index 9ba08dae0dfbc..7704a60d430a1 100644 --- a/content/en/api/v2/reference-tables/examples.json +++ b/content/en/api/v2/reference-tables/examples.json @@ -91,7 +91,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The reference tables.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of TableResultV2DataAttributes object.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

UUID of the user who created the reference table.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

The definition of TableResultV2DataAttributesFileMetadata object.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

File metadata for reference tables created by cloud storage.

\n
\n
\n
\n
\n
\n

access_details

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetails object.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail object.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

The ID of the AWS account.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

The name of the AWS bucket.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail object.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

The Azure client ID.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

The name of the Azure container.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

The name of the Azure storage account.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

The ID of the Azure tenant.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail object.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

The name of the GCP bucket.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

The ID of the GCP project.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

The email of the GCP service account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the sync.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to sync.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

enum

\n

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. \nAllowed enum values: TABLE_SCHEMA_ERROR,FILE_FORMAT_ERROR,CONFIGURATION_ERROR,QUOTA_EXCEEDED,CONFLICT_ERROR,VALIDATION_ERROR,STATE_ERROR,OPERATION_ERROR,SYSTEM_ERROR

\n
\n \n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

File metadata for reference tables created by upload.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the creation/update.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to create/update.

\n
\n \n
\n
\n
\n
\n
\n

upload_id

\n
\n

string

\n

The upload ID that was used to create/update the table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

UUID of the user who last updated the reference table.

\n
\n \n
\n
\n
\n
\n
\n

row_count

\n
\n

int64

\n

The number of successfully processed rows in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

The definition of TableResultV2DataAttributesSchema object.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source

\n
\n

enum

\n

The source type for reference table data. Includes all possible source types that can appear in responses. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE,SERVICENOW,SALESFORCE,DATABRICKS,SNOWFLAKE

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

table_name

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

string

\n

The timestamp of the last update to the reference table in ISO 8601 format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The reference tables.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes that define the reference table's configuration and properties.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

UUID of the user who created the reference table.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional text describing the purpose or contents of this reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

Metadata specifying where and how to access the reference table's data file.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

File metadata for reference tables created by cloud storage.

\n
\n
\n
\n
\n
\n

access_details [required]

\n
\n

object

\n

Cloud storage access configuration for the reference table data file.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

Amazon Web Services S3 storage access configuration.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

AWS account ID where the S3 bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

S3 bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

Azure Blob Storage access configuration.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

Azure service principal (application) client ID with permissions to read from the container.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

Azure Blob Storage container containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

Azure storage account where the container is located.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

Azure Active Directory tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

Google Cloud Platform storage access configuration.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

GCP bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

GCP project ID where the bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

Service account email with read permissions for the GCS bucket.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the sync.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to sync.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

enum

\n

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. \nAllowed enum values: TABLE_SCHEMA_ERROR,FILE_FORMAT_ERROR,CONFIGURATION_ERROR,QUOTA_EXCEEDED,CONFLICT_ERROR,VALIDATION_ERROR,STATE_ERROR,OPERATION_ERROR,SYSTEM_ERROR

\n
\n \n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the creation/update.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to create/update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

UUID of the user who last updated the reference table.

\n
\n \n
\n
\n
\n
\n
\n

row_count

\n
\n

int64

\n

The number of successfully processed rows in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Schema defining the structure and columns of the reference table.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source

\n
\n

enum

\n

The source type for reference table data. Includes all possible source types that can appear in responses. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE,SERVICENOW,SALESFORCE,DATABRICKS,SNOWFLAKE

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The processing status of the table.

\n
\n \n
\n
\n
\n
\n
\n

table_name

\n
\n

string

\n

Unique name to identify this reference table. Used in enrichment processors and API calls.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for organizing and filtering reference tables.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

string

\n

When the reference table was last updated, in ISO 8601 format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -125,10 +125,16 @@ "created_by": "00000000-0000-0000-0000-000000000000", "description": "example description", "file_metadata": { - "access_details": {}, - "upload_id": "00000000-0000-0000-0000-000000000000" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -145,7 +151,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -158,7 +164,7 @@ "type": "reference_table" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of TableResultV2Data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of TableResultV2DataAttributes object.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

UUID of the user who created the reference table.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

The definition of TableResultV2DataAttributesFileMetadata object.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

File metadata for reference tables created by cloud storage.

\n
\n
\n
\n
\n
\n

access_details

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetails object.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail object.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

The ID of the AWS account.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

The name of the AWS bucket.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail object.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

The Azure client ID.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

The name of the Azure container.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

The name of the Azure storage account.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

The ID of the Azure tenant.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail object.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

The name of the GCP bucket.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

The ID of the GCP project.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

The email of the GCP service account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the sync.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to sync.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

enum

\n

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. \nAllowed enum values: TABLE_SCHEMA_ERROR,FILE_FORMAT_ERROR,CONFIGURATION_ERROR,QUOTA_EXCEEDED,CONFLICT_ERROR,VALIDATION_ERROR,STATE_ERROR,OPERATION_ERROR,SYSTEM_ERROR

\n
\n \n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

File metadata for reference tables created by upload.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the creation/update.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to create/update.

\n
\n \n
\n
\n
\n
\n
\n

upload_id

\n
\n

string

\n

The upload ID that was used to create/update the table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

UUID of the user who last updated the reference table.

\n
\n \n
\n
\n
\n
\n
\n

row_count

\n
\n

int64

\n

The number of successfully processed rows in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

The definition of TableResultV2DataAttributesSchema object.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source

\n
\n

enum

\n

The source type for reference table data. Includes all possible source types that can appear in responses. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE,SERVICENOW,SALESFORCE,DATABRICKS,SNOWFLAKE

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

table_name

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

string

\n

The timestamp of the last update to the reference table in ISO 8601 format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object containing the reference table configuration and state.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes that define the reference table's configuration and properties.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

UUID of the user who created the reference table.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional text describing the purpose or contents of this reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

Metadata specifying where and how to access the reference table's data file.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

File metadata for reference tables created by cloud storage.

\n
\n
\n
\n
\n
\n

access_details [required]

\n
\n

object

\n

Cloud storage access configuration for the reference table data file.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

Amazon Web Services S3 storage access configuration.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

AWS account ID where the S3 bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

S3 bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

Azure Blob Storage access configuration.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

Azure service principal (application) client ID with permissions to read from the container.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

Azure Blob Storage container containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

Azure storage account where the container is located.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

Azure Active Directory tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

Google Cloud Platform storage access configuration.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

GCP bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

GCP project ID where the bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

Service account email with read permissions for the GCS bucket.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the sync.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to sync.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

enum

\n

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. \nAllowed enum values: TABLE_SCHEMA_ERROR,FILE_FORMAT_ERROR,CONFIGURATION_ERROR,QUOTA_EXCEEDED,CONFLICT_ERROR,VALIDATION_ERROR,STATE_ERROR,OPERATION_ERROR,SYSTEM_ERROR

\n
\n \n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the creation/update.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to create/update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

UUID of the user who last updated the reference table.

\n
\n \n
\n
\n
\n
\n
\n

row_count

\n
\n

int64

\n

The number of successfully processed rows in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Schema defining the structure and columns of the reference table.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source

\n
\n

enum

\n

The source type for reference table data. Includes all possible source types that can appear in responses. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE,SERVICENOW,SALESFORCE,DATABRICKS,SNOWFLAKE

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The processing status of the table.

\n
\n \n
\n
\n
\n
\n
\n

table_name

\n
\n

string

\n

Unique name to identify this reference table. Used in enrichment processors and API calls.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for organizing and filtering reference tables.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

string

\n

When the reference table was last updated, in ISO 8601 format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -214,16 +220,16 @@ "schema": { "fields": [ { - "name": "", + "name": "field_1", "type": "STRING" } ], "primary_keys": [ - "" + "field_1" ] }, "source": "LOCAL_FILE", - "table_name": "" + "table_name": "table_1" }, "type": "reference_table" } @@ -258,23 +264,25 @@ "schema": { "fields": [ { - "name": "", + "name": "field_1", "type": "STRING" } ], "primary_keys": [ - "" + "field_1" ] }, "source": "LOCAL_FILE", - "table_name": "", - "tags": [] + "table_name": "table_1", + "tags": [ + "tag_1", + "tag_2" + ] }, - "id": "string", "type": "reference_table" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of CreateTableRequestData object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CreateTableRequestDataAttributes object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

The definition of CreateTableRequestDataAttributesFileMetadata object.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.

\n
\n
\n
\n
\n
\n

access_details [required]

\n
\n

object

\n

The definition of CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails object.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

The definition of CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail object.

\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

The ID of the AWS account.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name [required]

\n
\n

string

\n

The name of the Amazon S3 bucket.

\n
\n \n
\n
\n
\n
\n
\n

file_path [required]

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

The definition of CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail object.

\n
\n
\n
\n
\n
\n

azure_client_id [required]

\n
\n

string

\n

The Azure client ID.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name [required]

\n
\n

string

\n

The name of the Azure container.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name [required]

\n
\n

string

\n

The name of the Azure storage account.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id [required]

\n
\n

string

\n

The ID of the Azure tenant.

\n
\n \n
\n
\n
\n
\n
\n

file_path [required]

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

The definition of CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail object.

\n
\n
\n
\n
\n
\n

file_path [required]

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name [required]

\n
\n

string

\n

The name of the GCP bucket.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id [required]

\n
\n

string

\n

The ID of the GCP project.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email [required]

\n
\n

string

\n

The email of the GCP service account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sync_enabled [required]

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Local file metadata for create requests using the upload ID.

\n
\n
\n
\n
\n
\n

upload_id [required]

\n
\n

string

\n

The upload ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema [required]

\n
\n

object

\n

The definition of CreateTableRequestDataAttributesSchema object.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source type for creating reference table data. Only these source types can be created through this API. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object containing the table definition.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes that define the reference table's configuration and properties.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional text describing the purpose or contents of this reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

Metadata specifying where and how to access the reference table's data file.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.

\n
\n
\n
\n
\n
\n

access_details [required]

\n
\n

object

\n

Cloud storage access configuration for the reference table data file.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

Amazon Web Services S3 storage access configuration.

\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS account ID where the S3 bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name [required]

\n
\n

string

\n

S3 bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

file_path [required]

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

Azure Blob Storage access configuration.

\n
\n
\n
\n
\n
\n

azure_client_id [required]

\n
\n

string

\n

Azure service principal (application) client ID with permissions to read from the container.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name [required]

\n
\n

string

\n

Azure Blob Storage container containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name [required]

\n
\n

string

\n

Azure storage account where the container is located.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id [required]

\n
\n

string

\n

Azure Active Directory tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

file_path [required]

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

Google Cloud Platform storage access configuration.

\n
\n
\n
\n
\n
\n

file_path [required]

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name [required]

\n
\n

string

\n

GCP bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id [required]

\n
\n

string

\n

GCP project ID where the bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email [required]

\n
\n

string

\n

Service account email with read permissions for the GCS bucket.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sync_enabled [required]

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Local file metadata for create requests using the upload ID.

\n
\n
\n
\n
\n
\n

upload_id [required]

\n
\n

string

\n

The upload ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema [required]

\n
\n

object

\n

Schema defining the structure and columns of the reference table.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source [required]

\n
\n

enum

\n

The source type for creating reference table data. Only these source types can be created through this API. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

Name to identify this reference table.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for organizing and filtering reference tables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" } }, "DeleteTable": { @@ -319,10 +327,16 @@ "created_by": "00000000-0000-0000-0000-000000000000", "description": "example description", "file_metadata": { - "access_details": {}, - "upload_id": "00000000-0000-0000-0000-000000000000" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -339,7 +353,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -352,7 +366,7 @@ "type": "reference_table" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of TableResultV2Data object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of TableResultV2DataAttributes object.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

UUID of the user who created the reference table.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

The definition of TableResultV2DataAttributesFileMetadata object.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

File metadata for reference tables created by cloud storage.

\n
\n
\n
\n
\n
\n

access_details

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetails object.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail object.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

The ID of the AWS account.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

The name of the AWS bucket.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail object.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

The Azure client ID.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

The name of the Azure container.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

The name of the Azure storage account.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

The ID of the Azure tenant.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

The definition of TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail object.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

The name of the GCP bucket.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

The ID of the GCP project.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

The email of the GCP service account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the sync.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to sync.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

enum

\n

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. \nAllowed enum values: TABLE_SCHEMA_ERROR,FILE_FORMAT_ERROR,CONFIGURATION_ERROR,QUOTA_EXCEEDED,CONFLICT_ERROR,VALIDATION_ERROR,STATE_ERROR,OPERATION_ERROR,SYSTEM_ERROR

\n
\n \n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

File metadata for reference tables created by upload.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the creation/update.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to create/update.

\n
\n \n
\n
\n
\n
\n
\n

upload_id

\n
\n

string

\n

The upload ID that was used to create/update the table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

UUID of the user who last updated the reference table.

\n
\n \n
\n
\n
\n
\n
\n

row_count

\n
\n

int64

\n

The number of successfully processed rows in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

The definition of TableResultV2DataAttributesSchema object.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source

\n
\n

enum

\n

The source type for reference table data. Includes all possible source types that can appear in responses. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE,SERVICENOW,SALESFORCE,DATABRICKS,SNOWFLAKE

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The status of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

table_name

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

string

\n

The timestamp of the last update to the reference table in ISO 8601 format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object containing the reference table configuration and state.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes that define the reference table's configuration and properties.

\n
\n
\n
\n
\n
\n

created_by

\n
\n

string

\n

UUID of the user who created the reference table.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional text describing the purpose or contents of this reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

Metadata specifying where and how to access the reference table's data file.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

File metadata for reference tables created by cloud storage.

\n
\n
\n
\n
\n
\n

access_details [required]

\n
\n

object

\n

Cloud storage access configuration for the reference table data file.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

Amazon Web Services S3 storage access configuration.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

AWS account ID where the S3 bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

S3 bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

Azure Blob Storage access configuration.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

Azure service principal (application) client ID with permissions to read from the container.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

Azure Blob Storage container containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

Azure storage account where the container is located.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

Azure Active Directory tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

Google Cloud Platform storage access configuration.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

GCP bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

GCP project ID where the bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

Service account email with read permissions for the GCS bucket.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the sync.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to sync.

\n
\n \n
\n
\n
\n
\n
\n

error_type

\n
\n

enum

\n

The type of error that occurred during file processing. This field provides high-level error categories for easier troubleshooting and is only present when there are errors. \nAllowed enum values: TABLE_SCHEMA_ERROR,FILE_FORMAT_ERROR,CONFIGURATION_ERROR,QUOTA_EXCEEDED,CONFLICT_ERROR,VALIDATION_ERROR,STATE_ERROR,OPERATION_ERROR,SYSTEM_ERROR

\n
\n \n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

error_message

\n
\n

string

\n

The error message returned from the creation/update.

\n
\n \n
\n
\n
\n
\n
\n

error_row_count

\n
\n

int64

\n

The number of rows that failed to create/update.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

last_updated_by

\n
\n

string

\n

UUID of the user who last updated the reference table.

\n
\n \n
\n
\n
\n
\n
\n

row_count

\n
\n

int64

\n

The number of successfully processed rows in the reference table.

\n
\n \n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Schema defining the structure and columns of the reference table.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

source

\n
\n

enum

\n

The source type for reference table data. Includes all possible source types that can appear in responses. \nAllowed enum values: LOCAL_FILE,S3,GCS,AZURE,SERVICENOW,SALESFORCE,DATABRICKS,SNOWFLAKE

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The processing status of the table.

\n
\n \n
\n
\n
\n
\n
\n

table_name

\n
\n

string

\n

Unique name to identify this reference table. Used in enrichment processors and API calls.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for organizing and filtering reference tables.

\n
\n \n
\n
\n
\n
\n
\n

updated_at

\n
\n

string

\n

When the reference table was last updated, in ISO 8601 format.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -419,12 +433,12 @@ "schema": { "fields": [ { - "name": "", + "name": "field_1", "type": "STRING" } ], "primary_keys": [ - "" + "field_1" ] } }, @@ -434,7 +448,7 @@ "json": { "data": { "attributes": { - "description": "string", + "description": "example description", "file_metadata": { "access_details": { "aws_detail": { @@ -461,22 +475,24 @@ "schema": { "fields": [ { - "name": "", + "name": "field_1", "type": "STRING" } ], "primary_keys": [ - "" + "field_1" ] }, "sync_enabled": false, - "tags": [] + "tags": [ + "tag_1", + "tag_2" + ] }, - "id": "string", "type": "reference_table" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of PatchTableRequestData object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of PatchTableRequestDataAttributes object.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

The definition of PatchTableRequestDataAttributesFileMetadata object.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.

\n
\n
\n
\n
\n
\n

access_details

\n
\n

object

\n

The definition of PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails object.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

The definition of PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail object.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

The ID of the AWS account.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

The name of the AWS bucket.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

The definition of PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail object.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

The Azure client ID.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

The name of the Azure container.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

The name of the Azure storage account.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

The ID of the Azure tenant.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

The definition of PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail object.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

The name of the GCP bucket.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

The ID of the GCP project.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

The email of the GCP service account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Local file metadata for patch requests using upload ID.

\n
\n
\n
\n
\n
\n

upload_id [required]

\n
\n

string

\n

The upload ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

The definition of PatchTableRequestDataAttributesSchema object.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The tags of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The data object containing the partial table definition updates.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes that define the updates to the reference table's configuration and properties.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Optional text describing the purpose or contents of this reference table.

\n
\n \n
\n
\n
\n
\n
\n

file_metadata

\n
\n

 <oneOf>

\n

Metadata specifying where and how to access the reference table's data file.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.

\n
\n
\n
\n
\n
\n

access_details

\n
\n

object

\n

Cloud storage access configuration for the reference table data file.

\n
\n
\n
\n
\n
\n

aws_detail

\n
\n

object

\n

Amazon Web Services S3 storage access configuration.

\n
\n
\n
\n
\n
\n

aws_account_id

\n
\n

string

\n

AWS account ID where the S3 bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

aws_bucket_name

\n
\n

string

\n

S3 bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the S3 bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

azure_detail

\n
\n

object

\n

Azure Blob Storage access configuration.

\n
\n
\n
\n
\n
\n

azure_client_id

\n
\n

string

\n

Azure service principal (application) client ID with permissions to read from the container.

\n
\n \n
\n
\n
\n
\n
\n

azure_container_name

\n
\n

string

\n

Azure Blob Storage container containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

azure_storage_account_name

\n
\n

string

\n

Azure storage account where the container is located.

\n
\n \n
\n
\n
\n
\n
\n

azure_tenant_id

\n
\n

string

\n

Azure Active Directory tenant ID.

\n
\n \n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the Azure container root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

gcp_detail

\n
\n

object

\n

Google Cloud Platform storage access configuration.

\n
\n
\n
\n
\n
\n

file_path

\n
\n

string

\n

The relative file path from the GCS bucket root to the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_bucket_name

\n
\n

string

\n

GCP bucket containing the CSV file.

\n
\n \n
\n
\n
\n
\n
\n

gcp_project_id

\n
\n

string

\n

GCP project ID where the bucket is located.

\n
\n \n
\n
\n
\n
\n
\n

gcp_service_account_email

\n
\n

string

\n

Service account email with read permissions for the GCS bucket.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

Local file metadata for patch requests using upload ID.

\n
\n
\n
\n
\n
\n

upload_id [required]

\n
\n

string

\n

The upload ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

schema

\n
\n

object

\n

Schema defining the updates to the structure and columns of the reference table. Schema fields cannot be deleted or renamed.

\n
\n
\n
\n
\n
\n

fields [required]

\n
\n

[object]

\n

The schema fields.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The field name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The field type for reference table schema fields. \nAllowed enum values: STRING,INT32

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

primary_keys [required]

\n
\n

[string]

\n

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.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sync_enabled

\n
\n

boolean

\n

Whether this table is synced automatically.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags for organizing and filtering reference tables.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Reference table resource type. \nAllowed enum values: reference_table

default: reference_table

\n
\n \n
\n
\n
\n
" } }, "GetRowsByID": { @@ -493,7 +509,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The rows.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of TableRowResourceDataAttributes object.

\n
\n
\n
\n
\n
\n

values

\n
\n

object

\n

The values of the row.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the row.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Row resource type. \nAllowed enum values: row

default: row

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The rows.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Column values for this row in the reference table.

\n
\n
\n
\n
\n
\n

values

\n
\n

object

\n

Key-value pairs representing the row data, where keys are field names from the schema.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Row identifier, corresponding to the primary key value.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Row resource type. \nAllowed enum values: row

default: row

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -538,7 +554,7 @@ "type": "upload" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of CreateUploadResponseData object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CreateUploadResponseDataAttributes object.

\n
\n
\n
\n
\n
\n

part_urls

\n
\n

[string]

\n

The URLs of the parts in the upload.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the upload.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Upload resource type. \nAllowed enum values: upload

default: upload

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Upload ID and attributes of the created upload.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Pre-signed URLs for uploading parts of the file.

\n
\n
\n
\n
\n
\n

part_urls

\n
\n

[string]

\n

The pre-signed URLs for uploading parts. These URLs expire after 5 minutes.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

Unique identifier for this upload. Use this ID when creating the reference table.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Upload resource type. \nAllowed enum values: upload

default: upload

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -570,7 +586,8 @@ "data": { "attributes": { "headers": [ - "" + "field_1", + "field_2" ], "part_count": 3, "part_size": 10000000, @@ -583,17 +600,17 @@ "data": { "attributes": { "headers": [ - "" + "field_1", + "field_2" ], "part_count": 3, "part_size": 10000000, "table_name": "" }, - "id": "string", "type": "upload" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of CreateUploadRequestData object.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The definition of CreateUploadRequestDataAttributes object.

\n
\n
\n
\n
\n
\n

headers [required]

\n
\n

[string]

\n

The headers of the file to upload.

\n
\n \n
\n
\n
\n
\n
\n

part_count [required]

\n
\n

int32

\n

The number of parts in the upload.

\n
\n \n
\n
\n
\n
\n
\n

part_size [required]

\n
\n

int64

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

The name of the reference table.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the upload.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Upload resource type. \nAllowed enum values: upload

default: upload

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Request data for creating an upload for a file to be ingested into a reference table.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Upload configuration specifying how data is uploaded by the user, and properties of the table to associate the upload with.

\n
\n
\n
\n
\n
\n

headers [required]

\n
\n

[string]

\n

The CSV file headers that define the schema fields, provided in the same order as the columns in the uploaded file.

\n
\n \n
\n
\n
\n
\n
\n

part_count [required]

\n
\n

int32

\n

Number of parts to split the file into for multipart upload.

\n
\n \n
\n
\n
\n
\n
\n

part_size [required]

\n
\n

int64

\n

The size of each part in the upload in bytes. All parts except the last one must be at least 5,000,000 bytes.

\n
\n \n
\n
\n
\n
\n
\n

table_name [required]

\n
\n

string

\n

Name of the table to associate with this upload.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Upload resource type. \nAllowed enum values: upload

default: upload

\n
\n \n
\n
\n
\n
" } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index a5c5eca3a49ae..c28cb0dcf70b4 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -12994,7 +12994,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: @@ -13024,23 +13025,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' @@ -13049,11 +13050,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 @@ -13063,8 +13067,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' @@ -13090,15 +13094,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' @@ -13108,15 +13112,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: @@ -13131,23 +13134,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: @@ -13165,8 +13168,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 @@ -13174,15 +13176,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: @@ -13194,10 +13196,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 @@ -13206,7 +13208,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 @@ -13215,12 +13217,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' @@ -13238,50 +13239,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: @@ -13300,18 +13302,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' @@ -13319,10 +13324,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 @@ -38393,7 +38399,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: @@ -38416,30 +38422,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' @@ -38447,16 +38453,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' @@ -38479,15 +38489,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' @@ -38497,15 +38507,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: @@ -38516,23 +38525,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: @@ -38544,8 +38553,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 @@ -38553,34 +38561,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 @@ -38589,12 +38598,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' @@ -51239,16 +51248,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: @@ -51258,7 +51272,7 @@ components: type: STRING primary_keys: - id - source: LOCAL_FILE + source: S3 status: DONE table_name: test_reference_table tags: @@ -51272,7 +51286,7 @@ components: $ref: '#/components/schemas/TableResultV2Data' type: object TableResultV2Array: - description: The definition of `TableResultV2Array` object. + description: List of reference tables. example: data: - attributes: @@ -51344,12 +51358,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' @@ -51357,22 +51373,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: @@ -51380,23 +51402,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' @@ -51417,6 +51446,8 @@ components: sync_enabled: description: Whether this table is synced automatically. type: boolean + required: + - access_details title: CloudFileMetadataV2 type: object TableResultV2DataAttributesFileMetadataCloudStorageErrorType: @@ -51445,7 +51476,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. @@ -51454,14 +51487,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' @@ -51471,15 +51501,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: @@ -51490,23 +51519,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: @@ -51518,8 +51547,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 @@ -51527,25 +51555,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 @@ -51554,7 +51582,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 @@ -51563,12 +51591,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' @@ -51586,7 +51613,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. @@ -51597,12 +51624,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' @@ -51610,11 +51638,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: @@ -74249,8 +74278,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 @@ -74298,12 +74327,12 @@ paths: - Reference Tables x-menu-order: 3 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: @@ -74337,7 +74366,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 @@ -74364,7 +74393,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 @@ -74402,7 +74431,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 @@ -74436,7 +74465,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/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index e7d69c6dbc8f9..a605f06ddbb29 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -83034,7 +83034,7 @@ ] }, "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": { @@ -83075,35 +83075,36 @@ }, "properties": { "data": { - "description": "The definition of `CreateTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the table definition.", "properties": { "attributes": { - "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83124,25 +83125,25 @@ ] }, "azure_detail": { - "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" }, @@ -83165,7 +83166,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83173,17 +83174,17 @@ "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" } @@ -83221,7 +83222,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -83234,16 +83235,16 @@ ] }, "schema": { - "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": { - "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": { @@ -83271,7 +83272,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -83303,12 +83304,16 @@ ] }, "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" }, @@ -83322,10 +83327,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -83348,35 +83349,36 @@ "type": "object" }, "CreateTableRequestData": { - "description": "The definition of `CreateTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the table definition.", "properties": { "attributes": { - "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83397,25 +83399,25 @@ ] }, "azure_detail": { - "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" }, @@ -83438,7 +83440,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83446,17 +83448,17 @@ "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" } @@ -83494,7 +83496,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -83507,16 +83509,16 @@ ] }, "schema": { - "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": { - "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": { @@ -83544,7 +83546,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -83576,12 +83578,16 @@ ] }, "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" }, @@ -83595,10 +83601,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -83618,32 +83620,32 @@ "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83664,25 +83666,25 @@ ] }, "azure_detail": { - "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" }, @@ -83705,7 +83707,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83713,17 +83715,17 @@ "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" } @@ -83761,7 +83763,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -83774,16 +83776,16 @@ ] }, "schema": { - "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": { - "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": { @@ -83811,7 +83813,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -83843,12 +83845,16 @@ ] }, "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" }, @@ -83863,25 +83869,25 @@ "type": "object" }, "CreateTableRequestDataAttributesFileMetadata": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83902,25 +83908,25 @@ ] }, "azure_detail": { - "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" }, @@ -83943,7 +83949,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83951,17 +83957,17 @@ "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" } @@ -83999,7 +84005,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -84016,18 +84022,18 @@ "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -84048,25 +84054,25 @@ ] }, "azure_detail": { - "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" }, @@ -84089,7 +84095,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -84097,17 +84103,17 @@ "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" } @@ -84145,7 +84151,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -84156,18 +84162,18 @@ "type": "object" }, "CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -84188,25 +84194,25 @@ ] }, "azure_detail": { - "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" }, @@ -84229,7 +84235,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -84237,17 +84243,17 @@ "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" } @@ -84267,15 +84273,15 @@ "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" }, @@ -84296,25 +84302,25 @@ ] }, "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" }, @@ -84337,7 +84343,7 @@ ] }, "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 file.", @@ -84345,17 +84351,17 @@ "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" } @@ -84372,16 +84378,16 @@ ] }, "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": { - "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": { @@ -84409,7 +84415,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -84424,11 +84430,11 @@ "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": { @@ -84464,18 +84470,20 @@ ] }, "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": { - "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": { - "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" @@ -84483,20 +84491,20 @@ "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" } @@ -84509,10 +84517,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the upload.", - "type": "string" - }, "type": { "default": "upload", "description": "Upload resource type.", @@ -84535,15 +84539,17 @@ "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": { - "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" @@ -84551,20 +84557,20 @@ "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" } @@ -84577,10 +84583,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the upload.", - "type": "string" - }, "type": { "default": "upload", "description": "Upload resource type.", @@ -84600,12 +84602,13 @@ "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" @@ -84613,20 +84616,20 @@ "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" } @@ -84652,16 +84655,17 @@ ] }, "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": { - "description": "The definition of `CreateUploadResponseData` object.", + "additionalProperties": false, + "description": "Upload ID and attributes of the created upload.", "properties": { "attributes": { - "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" }, @@ -84671,7 +84675,7 @@ "type": "object" }, "id": { - "description": "The ID of the upload.", + "description": "Unique identifier for this upload. Use this ID when creating the reference table.", "type": "string" }, "type": { @@ -84696,13 +84700,14 @@ "type": "object" }, "CreateUploadResponseData": { - "description": "The definition of `CreateUploadResponseData` object.", + "additionalProperties": false, + "description": "Upload ID and attributes of the created upload.", "properties": { "attributes": { - "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" }, @@ -84712,7 +84717,7 @@ "type": "object" }, "id": { - "description": "The ID of the upload.", + "description": "Unique identifier for this upload. Use this ID when creating the reference table.", "type": "string" }, "type": { @@ -84734,10 +84739,10 @@ "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" }, @@ -273896,7 +273901,7 @@ "type": "object" }, "PatchTableRequest": { - "description": "The definition of `PatchTableRequest` object.", + "description": "Request body for updating an existing reference table.", "example": { "data": { "attributes": { @@ -273931,41 +273936,42 @@ "test_tag" ] }, - "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table" } }, "properties": { "data": { - "description": "The definition of `PatchTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the partial table definition updates.", "properties": { "attributes": { - "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -273981,25 +273987,25 @@ ] }, "azure_detail": { - "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" }, @@ -274015,7 +274021,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274023,17 +274029,17 @@ "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" } @@ -274061,7 +274067,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274074,16 +274080,16 @@ ] }, "schema": { - "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": { - "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": { @@ -274109,9 +274115,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -274127,10 +274133,15 @@ }, "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" }, @@ -274139,10 +274150,6 @@ }, "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -274165,35 +274172,37 @@ "type": "object" }, "PatchTableRequestData": { - "description": "The definition of `PatchTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the partial table definition updates.", "properties": { "attributes": { - "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274209,25 +274218,25 @@ ] }, "azure_detail": { - "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" }, @@ -274243,7 +274252,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274251,17 +274260,17 @@ "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" } @@ -274289,7 +274298,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274302,16 +274311,16 @@ ] }, "schema": { - "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": { - "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": { @@ -274337,9 +274346,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -274355,10 +274364,15 @@ }, "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" }, @@ -274367,10 +274381,6 @@ }, "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -274390,32 +274400,33 @@ "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274431,25 +274442,25 @@ ] }, "azure_detail": { - "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" }, @@ -274465,7 +274476,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274473,17 +274484,17 @@ "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" } @@ -274511,7 +274522,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274524,16 +274535,16 @@ ] }, "schema": { - "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": { - "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": { @@ -274559,9 +274570,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -274577,10 +274588,15 @@ }, "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" }, @@ -274590,25 +274606,25 @@ "type": "object" }, "PatchTableRequestDataAttributesFileMetadata": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274624,25 +274640,25 @@ ] }, "azure_detail": { - "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" }, @@ -274658,7 +274674,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274666,17 +274682,17 @@ "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" } @@ -274704,7 +274720,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274721,18 +274737,18 @@ "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274748,25 +274764,25 @@ ] }, "azure_detail": { - "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" }, @@ -274782,7 +274798,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274790,17 +274806,17 @@ "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" } @@ -274828,7 +274844,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274839,18 +274855,18 @@ "type": "object" }, "PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274866,25 +274882,25 @@ ] }, "azure_detail": { - "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" }, @@ -274900,7 +274916,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274908,17 +274924,17 @@ "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" } @@ -274932,15 +274948,15 @@ "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" }, @@ -274956,25 +274972,25 @@ ] }, "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" }, @@ -274990,7 +275006,7 @@ ] }, "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 file.", @@ -274998,17 +275014,17 @@ "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" } @@ -275019,16 +275035,16 @@ ] }, "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": { - "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": { @@ -275054,9 +275070,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -275071,11 +275087,11 @@ "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": { @@ -358026,17 +358042,23 @@ "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" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -358053,7 +358075,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -358068,38 +358090,41 @@ }, "properties": { "data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -358115,25 +358140,25 @@ ] }, "azure_detail": { - "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" }, @@ -358149,7 +358174,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -358157,17 +358182,17 @@ "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" } @@ -358220,11 +358245,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -358234,10 +358262,6 @@ "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", @@ -358247,24 +358271,26 @@ }, "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": { - "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": { - "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": { @@ -358292,7 +358318,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -358332,29 +358358,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -358379,7 +358412,7 @@ "type": "object" }, "TableResultV2Array": { - "description": "The definition of `TableResultV2Array` object.", + "description": "List of reference tables.", "example": { "data": [ { @@ -358473,38 +358506,41 @@ "data": { "description": "The reference tables.", "items": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -358520,25 +358556,25 @@ ] }, "azure_detail": { - "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" }, @@ -358554,7 +358590,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -358562,17 +358598,17 @@ "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" } @@ -358625,11 +358661,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -358639,10 +358678,6 @@ "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", @@ -358652,24 +358687,26 @@ }, "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": { - "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": { - "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": { @@ -358697,7 +358734,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -358737,29 +358774,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -358789,38 +358833,41 @@ "type": "object" }, "TableResultV2Data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -358836,25 +358883,25 @@ ] }, "azure_detail": { - "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" }, @@ -358870,7 +358917,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -358878,17 +358925,17 @@ "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" } @@ -358941,11 +358988,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -358955,10 +359005,6 @@ "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", @@ -358968,24 +359014,26 @@ }, "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": { - "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": { - "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": { @@ -359013,7 +359061,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -359053,29 +359101,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -359097,35 +359152,37 @@ "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -359141,25 +359198,25 @@ ] }, "azure_detail": { - "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" }, @@ -359175,7 +359232,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359183,17 +359240,17 @@ "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" } @@ -359246,11 +359303,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -359260,10 +359320,6 @@ "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", @@ -359273,24 +359329,26 @@ }, "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": { - "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": { - "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": { @@ -359318,7 +359376,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -359358,46 +359416,53 @@ ] }, "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": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -359413,25 +359478,25 @@ ] }, "azure_detail": { - "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" }, @@ -359447,7 +359512,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359455,17 +359520,17 @@ "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" } @@ -359518,11 +359583,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -359532,10 +359600,6 @@ "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", @@ -359547,18 +359611,18 @@ "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -359574,25 +359638,25 @@ ] }, "azure_detail": { - "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" }, @@ -359608,7 +359672,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359616,17 +359680,17 @@ "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" } @@ -359679,6 +359743,9 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, @@ -359709,7 +359776,7 @@ ] }, "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.", @@ -359719,28 +359786,24 @@ "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": { - "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" }, @@ -359756,25 +359819,25 @@ ] }, "azure_detail": { - "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" }, @@ -359790,7 +359853,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359798,17 +359861,17 @@ "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" } @@ -359822,15 +359885,15 @@ "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" }, @@ -359846,25 +359909,25 @@ ] }, "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" }, @@ -359880,7 +359943,7 @@ ] }, "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 file.", @@ -359888,17 +359951,17 @@ "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" } @@ -359909,16 +359972,16 @@ ] }, "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": { - "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": { @@ -359946,7 +360009,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -359961,11 +360024,11 @@ "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": { @@ -360001,26 +360064,27 @@ ] }, "TableRowResourceArray": { - "description": "The definition of `TableRowResourceArray` object.", + "description": "List of rows from a reference table query.", "properties": { "data": { "description": "The rows.", "items": { - "description": "The definition of `TableRowResourceData` object.", + "additionalProperties": false, + "description": "The data object containing the row column names and values.", "properties": { "attributes": { - "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" }, "id": { - "description": "The ID of the row.", + "description": "Row identifier, corresponding to the primary key value.", "type": "string" }, "type": { @@ -360050,21 +360114,22 @@ "type": "object" }, "TableRowResourceData": { - "description": "The definition of `TableRowResourceData` object.", + "additionalProperties": false, + "description": "The data object containing the row column names and values.", "properties": { "attributes": { - "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" }, "id": { - "description": "The ID of the row.", + "description": "Row identifier, corresponding to the primary key value.", "type": "string" }, "type": { @@ -360086,11 +360151,11 @@ "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" } }, @@ -596725,7 +596790,7 @@ } }, { - "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", @@ -596788,7 +596853,7 @@ "content": { "application/json": { "schema": { - "description": "The definition of `TableResultV2Array` object.", + "description": "List of reference tables.", "example": { "data": [ { @@ -596882,38 +596947,41 @@ "data": { "description": "The reference tables.", "items": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -596929,25 +596997,25 @@ ] }, "azure_detail": { - "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" }, @@ -596963,7 +597031,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -596971,17 +597039,17 @@ "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" } @@ -597034,11 +597102,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -597048,10 +597119,6 @@ "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", @@ -597061,24 +597128,26 @@ }, "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": { - "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": { - "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": { @@ -597106,7 +597175,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -597146,29 +597215,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -597274,13 +597350,13 @@ "x-menu-order": 3 }, "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": { "application/json": { "schema": { - "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": { @@ -597321,35 +597397,36 @@ }, "properties": { "data": { - "description": "The definition of `CreateTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the table definition.", "properties": { "attributes": { - "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -597370,25 +597447,25 @@ ] }, "azure_detail": { - "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" }, @@ -597411,7 +597488,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -597419,17 +597496,17 @@ "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" } @@ -597467,7 +597544,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -597480,16 +597557,16 @@ ] }, "schema": { - "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": { - "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": { @@ -597517,7 +597594,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -597549,12 +597626,16 @@ ] }, "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" }, @@ -597568,10 +597649,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -597602,17 +597679,23 @@ "content": { "application/json": { "schema": { - "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" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -597629,7 +597712,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -597644,38 +597727,41 @@ }, "properties": { "data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -597691,25 +597777,25 @@ ] }, "azure_detail": { - "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" }, @@ -597725,7 +597811,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -597733,17 +597819,17 @@ "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" } @@ -597796,11 +597882,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -597810,10 +597899,6 @@ "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", @@ -597823,24 +597908,26 @@ }, "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": { - "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": { - "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": { @@ -597868,7 +597955,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -597908,29 +597995,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -598065,7 +598159,7 @@ "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, @@ -598183,7 +598277,7 @@ "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, @@ -598197,17 +598291,23 @@ "content": { "application/json": { "schema": { - "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" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -598224,7 +598324,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -598239,38 +598339,41 @@ }, "properties": { "data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -598286,25 +598389,25 @@ ] }, "azure_detail": { - "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" }, @@ -598320,7 +598423,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -598328,17 +598431,17 @@ "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" } @@ -598391,11 +598494,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -598405,10 +598511,6 @@ "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", @@ -598418,24 +598520,26 @@ }, "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": { - "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": { - "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": { @@ -598463,7 +598567,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -598503,29 +598607,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -598658,7 +598769,7 @@ "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, @@ -598671,7 +598782,7 @@ "content": { "application/json": { "schema": { - "description": "The definition of `PatchTableRequest` object.", + "description": "Request body for updating an existing reference table.", "example": { "data": { "attributes": { @@ -598706,41 +598817,42 @@ "test_tag" ] }, - "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table" } }, "properties": { "data": { - "description": "The definition of `PatchTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the partial table definition updates.", "properties": { "attributes": { - "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -598756,25 +598868,25 @@ ] }, "azure_detail": { - "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" }, @@ -598790,7 +598902,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -598798,17 +598910,17 @@ "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" } @@ -598836,7 +598948,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -598849,16 +598961,16 @@ ] }, "schema": { - "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": { - "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": { @@ -598884,9 +598996,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -598902,10 +599014,15 @@ }, "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" }, @@ -598914,10 +599031,6 @@ }, "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -599054,7 +599167,7 @@ "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", @@ -599086,26 +599199,27 @@ "content": { "application/json": { "schema": { - "description": "The definition of `TableRowResourceArray` object.", + "description": "List of rows from a reference table query.", "properties": { "data": { "description": "The rows.", "items": { - "description": "The definition of `TableRowResourceData` object.", + "additionalProperties": false, + "description": "The data object containing the row column names and values.", "properties": { "attributes": { - "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" }, "id": { - "description": "The ID of the row.", + "description": "Row identifier, corresponding to the primary key value.", "type": "string" }, "type": { @@ -599247,18 +599361,20 @@ "content": { "application/json": { "schema": { - "description": "The definition of `CreateUploadRequest` object.", + "description": "Request to create an upload for a file to be ingested into a reference table.", "properties": { "data": { - "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": { - "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" @@ -599266,20 +599382,20 @@ "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" } @@ -599292,10 +599408,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the upload.", - "type": "string" - }, "type": { "default": "upload", "description": "Upload resource type.", @@ -599326,16 +599438,17 @@ "content": { "application/json": { "schema": { - "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": { - "description": "The definition of `CreateUploadResponseData` object.", + "additionalProperties": false, + "description": "Upload ID and attributes of the created upload.", "properties": { "attributes": { - "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" }, @@ -599345,7 +599458,7 @@ "type": "object" }, "id": { - "description": "The ID of the upload.", + "description": "Unique identifier for this upload. Use this ID when creating the reference table.", "type": "string" }, "type": { diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 80749d97851b3..931dfa2de5124 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -2101,10 +2101,10 @@ "summary": "List tables" }, "CreateReferenceTable": { - "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.", "summary": "Create reference table", "request_description": "", - "request_schema_description": "The definition of `CreateTableRequest` object." + "request_schema_description": "Request body for creating a new reference table from a local file or cloud storage." }, "DeleteTable": { "description": "Delete a reference table by ID", @@ -2118,7 +2118,7 @@ "description": "Update a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type `source:LOCAL_FILE`, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with `source:` types of `S3`, `GCS`, or `AZURE`, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage.", "summary": "Update reference table", "request_description": "", - "request_schema_description": "The definition of `PatchTableRequest` object." + "request_schema_description": "Request body for updating an existing reference table." }, "GetRowsByID": { "description": "Get reference table rows by their primary key values.", @@ -2128,7 +2128,7 @@ "description": "Create a reference table upload for bulk data ingestion", "summary": "Create reference table upload", "request_description": "", - "request_schema_description": "The definition of `CreateUploadRequest` object." + "request_schema_description": "Request to create an upload for a file to be ingested into a reference table." }, "ListApplicationSecurityWAFCustomRules": { "description": "Retrieve a list of WAF custom rule.", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index e7d69c6dbc8f9..a605f06ddbb29 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -83034,7 +83034,7 @@ ] }, "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": { @@ -83075,35 +83075,36 @@ }, "properties": { "data": { - "description": "The definition of `CreateTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the table definition.", "properties": { "attributes": { - "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83124,25 +83125,25 @@ ] }, "azure_detail": { - "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" }, @@ -83165,7 +83166,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83173,17 +83174,17 @@ "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" } @@ -83221,7 +83222,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -83234,16 +83235,16 @@ ] }, "schema": { - "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": { - "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": { @@ -83271,7 +83272,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -83303,12 +83304,16 @@ ] }, "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" }, @@ -83322,10 +83327,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -83348,35 +83349,36 @@ "type": "object" }, "CreateTableRequestData": { - "description": "The definition of `CreateTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the table definition.", "properties": { "attributes": { - "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83397,25 +83399,25 @@ ] }, "azure_detail": { - "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" }, @@ -83438,7 +83440,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83446,17 +83448,17 @@ "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" } @@ -83494,7 +83496,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -83507,16 +83509,16 @@ ] }, "schema": { - "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": { - "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": { @@ -83544,7 +83546,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -83576,12 +83578,16 @@ ] }, "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" }, @@ -83595,10 +83601,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -83618,32 +83620,32 @@ "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83664,25 +83666,25 @@ ] }, "azure_detail": { - "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" }, @@ -83705,7 +83707,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83713,17 +83715,17 @@ "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" } @@ -83761,7 +83763,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -83774,16 +83776,16 @@ ] }, "schema": { - "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": { - "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": { @@ -83811,7 +83813,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -83843,12 +83845,16 @@ ] }, "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" }, @@ -83863,25 +83869,25 @@ "type": "object" }, "CreateTableRequestDataAttributesFileMetadata": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -83902,25 +83908,25 @@ ] }, "azure_detail": { - "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" }, @@ -83943,7 +83949,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -83951,17 +83957,17 @@ "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" } @@ -83999,7 +84005,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -84016,18 +84022,18 @@ "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -84048,25 +84054,25 @@ ] }, "azure_detail": { - "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" }, @@ -84089,7 +84095,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -84097,17 +84103,17 @@ "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" } @@ -84145,7 +84151,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -84156,18 +84162,18 @@ "type": "object" }, "CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -84188,25 +84194,25 @@ ] }, "azure_detail": { - "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" }, @@ -84229,7 +84235,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -84237,17 +84243,17 @@ "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" } @@ -84267,15 +84273,15 @@ "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" }, @@ -84296,25 +84302,25 @@ ] }, "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" }, @@ -84337,7 +84343,7 @@ ] }, "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 file.", @@ -84345,17 +84351,17 @@ "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" } @@ -84372,16 +84378,16 @@ ] }, "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": { - "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": { @@ -84409,7 +84415,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -84424,11 +84430,11 @@ "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": { @@ -84464,18 +84470,20 @@ ] }, "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": { - "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": { - "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" @@ -84483,20 +84491,20 @@ "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" } @@ -84509,10 +84517,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the upload.", - "type": "string" - }, "type": { "default": "upload", "description": "Upload resource type.", @@ -84535,15 +84539,17 @@ "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": { - "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" @@ -84551,20 +84557,20 @@ "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" } @@ -84577,10 +84583,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the upload.", - "type": "string" - }, "type": { "default": "upload", "description": "Upload resource type.", @@ -84600,12 +84602,13 @@ "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" @@ -84613,20 +84616,20 @@ "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" } @@ -84652,16 +84655,17 @@ ] }, "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": { - "description": "The definition of `CreateUploadResponseData` object.", + "additionalProperties": false, + "description": "Upload ID and attributes of the created upload.", "properties": { "attributes": { - "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" }, @@ -84671,7 +84675,7 @@ "type": "object" }, "id": { - "description": "The ID of the upload.", + "description": "Unique identifier for this upload. Use this ID when creating the reference table.", "type": "string" }, "type": { @@ -84696,13 +84700,14 @@ "type": "object" }, "CreateUploadResponseData": { - "description": "The definition of `CreateUploadResponseData` object.", + "additionalProperties": false, + "description": "Upload ID and attributes of the created upload.", "properties": { "attributes": { - "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" }, @@ -84712,7 +84717,7 @@ "type": "object" }, "id": { - "description": "The ID of the upload.", + "description": "Unique identifier for this upload. Use this ID when creating the reference table.", "type": "string" }, "type": { @@ -84734,10 +84739,10 @@ "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" }, @@ -273896,7 +273901,7 @@ "type": "object" }, "PatchTableRequest": { - "description": "The definition of `PatchTableRequest` object.", + "description": "Request body for updating an existing reference table.", "example": { "data": { "attributes": { @@ -273931,41 +273936,42 @@ "test_tag" ] }, - "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table" } }, "properties": { "data": { - "description": "The definition of `PatchTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the partial table definition updates.", "properties": { "attributes": { - "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -273981,25 +273987,25 @@ ] }, "azure_detail": { - "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" }, @@ -274015,7 +274021,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274023,17 +274029,17 @@ "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" } @@ -274061,7 +274067,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274074,16 +274080,16 @@ ] }, "schema": { - "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": { - "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": { @@ -274109,9 +274115,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -274127,10 +274133,15 @@ }, "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" }, @@ -274139,10 +274150,6 @@ }, "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -274165,35 +274172,37 @@ "type": "object" }, "PatchTableRequestData": { - "description": "The definition of `PatchTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the partial table definition updates.", "properties": { "attributes": { - "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274209,25 +274218,25 @@ ] }, "azure_detail": { - "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" }, @@ -274243,7 +274252,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274251,17 +274260,17 @@ "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" } @@ -274289,7 +274298,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274302,16 +274311,16 @@ ] }, "schema": { - "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": { - "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": { @@ -274337,9 +274346,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -274355,10 +274364,15 @@ }, "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" }, @@ -274367,10 +274381,6 @@ }, "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -274390,32 +274400,33 @@ "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274431,25 +274442,25 @@ ] }, "azure_detail": { - "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" }, @@ -274465,7 +274476,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274473,17 +274484,17 @@ "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" } @@ -274511,7 +274522,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274524,16 +274535,16 @@ ] }, "schema": { - "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": { - "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": { @@ -274559,9 +274570,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -274577,10 +274588,15 @@ }, "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" }, @@ -274590,25 +274606,25 @@ "type": "object" }, "PatchTableRequestDataAttributesFileMetadata": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274624,25 +274640,25 @@ ] }, "azure_detail": { - "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" }, @@ -274658,7 +274674,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274666,17 +274682,17 @@ "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" } @@ -274704,7 +274720,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274721,18 +274737,18 @@ "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274748,25 +274764,25 @@ ] }, "azure_detail": { - "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" }, @@ -274782,7 +274798,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274790,17 +274806,17 @@ "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" } @@ -274828,7 +274844,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -274839,18 +274855,18 @@ "type": "object" }, "PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -274866,25 +274882,25 @@ ] }, "azure_detail": { - "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" }, @@ -274900,7 +274916,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -274908,17 +274924,17 @@ "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" } @@ -274932,15 +274948,15 @@ "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" }, @@ -274956,25 +274972,25 @@ ] }, "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" }, @@ -274990,7 +275006,7 @@ ] }, "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 file.", @@ -274998,17 +275014,17 @@ "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" } @@ -275019,16 +275035,16 @@ ] }, "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": { - "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": { @@ -275054,9 +275070,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -275071,11 +275087,11 @@ "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": { @@ -358026,17 +358042,23 @@ "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" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -358053,7 +358075,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -358068,38 +358090,41 @@ }, "properties": { "data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -358115,25 +358140,25 @@ ] }, "azure_detail": { - "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" }, @@ -358149,7 +358174,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -358157,17 +358182,17 @@ "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" } @@ -358220,11 +358245,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -358234,10 +358262,6 @@ "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", @@ -358247,24 +358271,26 @@ }, "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": { - "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": { - "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": { @@ -358292,7 +358318,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -358332,29 +358358,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -358379,7 +358412,7 @@ "type": "object" }, "TableResultV2Array": { - "description": "The definition of `TableResultV2Array` object.", + "description": "List of reference tables.", "example": { "data": [ { @@ -358473,38 +358506,41 @@ "data": { "description": "The reference tables.", "items": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -358520,25 +358556,25 @@ ] }, "azure_detail": { - "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" }, @@ -358554,7 +358590,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -358562,17 +358598,17 @@ "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" } @@ -358625,11 +358661,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -358639,10 +358678,6 @@ "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", @@ -358652,24 +358687,26 @@ }, "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": { - "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": { - "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": { @@ -358697,7 +358734,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -358737,29 +358774,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -358789,38 +358833,41 @@ "type": "object" }, "TableResultV2Data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -358836,25 +358883,25 @@ ] }, "azure_detail": { - "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" }, @@ -358870,7 +358917,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -358878,17 +358925,17 @@ "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" } @@ -358941,11 +358988,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -358955,10 +359005,6 @@ "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", @@ -358968,24 +359014,26 @@ }, "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": { - "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": { - "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": { @@ -359013,7 +359061,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -359053,29 +359101,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -359097,35 +359152,37 @@ "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -359141,25 +359198,25 @@ ] }, "azure_detail": { - "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" }, @@ -359175,7 +359232,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359183,17 +359240,17 @@ "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" } @@ -359246,11 +359303,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -359260,10 +359320,6 @@ "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", @@ -359273,24 +359329,26 @@ }, "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": { - "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": { - "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": { @@ -359318,7 +359376,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -359358,46 +359416,53 @@ ] }, "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": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -359413,25 +359478,25 @@ ] }, "azure_detail": { - "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" }, @@ -359447,7 +359512,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359455,17 +359520,17 @@ "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" } @@ -359518,11 +359583,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -359532,10 +359600,6 @@ "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", @@ -359547,18 +359611,18 @@ "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -359574,25 +359638,25 @@ ] }, "azure_detail": { - "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" }, @@ -359608,7 +359672,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359616,17 +359680,17 @@ "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" } @@ -359679,6 +359743,9 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, @@ -359709,7 +359776,7 @@ ] }, "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.", @@ -359719,28 +359786,24 @@ "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": { - "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" }, @@ -359756,25 +359819,25 @@ ] }, "azure_detail": { - "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" }, @@ -359790,7 +359853,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -359798,17 +359861,17 @@ "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" } @@ -359822,15 +359885,15 @@ "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" }, @@ -359846,25 +359909,25 @@ ] }, "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" }, @@ -359880,7 +359943,7 @@ ] }, "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 file.", @@ -359888,17 +359951,17 @@ "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" } @@ -359909,16 +359972,16 @@ ] }, "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": { - "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": { @@ -359946,7 +360009,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -359961,11 +360024,11 @@ "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": { @@ -360001,26 +360064,27 @@ ] }, "TableRowResourceArray": { - "description": "The definition of `TableRowResourceArray` object.", + "description": "List of rows from a reference table query.", "properties": { "data": { "description": "The rows.", "items": { - "description": "The definition of `TableRowResourceData` object.", + "additionalProperties": false, + "description": "The data object containing the row column names and values.", "properties": { "attributes": { - "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" }, "id": { - "description": "The ID of the row.", + "description": "Row identifier, corresponding to the primary key value.", "type": "string" }, "type": { @@ -360050,21 +360114,22 @@ "type": "object" }, "TableRowResourceData": { - "description": "The definition of `TableRowResourceData` object.", + "additionalProperties": false, + "description": "The data object containing the row column names and values.", "properties": { "attributes": { - "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" }, "id": { - "description": "The ID of the row.", + "description": "Row identifier, corresponding to the primary key value.", "type": "string" }, "type": { @@ -360086,11 +360151,11 @@ "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" } }, @@ -596725,7 +596790,7 @@ } }, { - "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", @@ -596788,7 +596853,7 @@ "content": { "application/json": { "schema": { - "description": "The definition of `TableResultV2Array` object.", + "description": "List of reference tables.", "example": { "data": [ { @@ -596882,38 +596947,41 @@ "data": { "description": "The reference tables.", "items": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -596929,25 +596997,25 @@ ] }, "azure_detail": { - "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" }, @@ -596963,7 +597031,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -596971,17 +597039,17 @@ "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" } @@ -597034,11 +597102,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -597048,10 +597119,6 @@ "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", @@ -597061,24 +597128,26 @@ }, "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": { - "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": { - "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": { @@ -597106,7 +597175,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -597146,29 +597215,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -597274,13 +597350,13 @@ "x-menu-order": 3 }, "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": { "application/json": { "schema": { - "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": { @@ -597321,35 +597397,36 @@ }, "properties": { "data": { - "description": "The definition of `CreateTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the table definition.", "properties": { "attributes": { - "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": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.", "properties": { "access_details": { - "description": "The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -597370,25 +597447,25 @@ ] }, "azure_detail": { - "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" }, @@ -597411,7 +597488,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -597419,17 +597496,17 @@ "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" } @@ -597467,7 +597544,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -597480,16 +597557,16 @@ ] }, "schema": { - "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": { - "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": { @@ -597517,7 +597594,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -597549,12 +597626,16 @@ ] }, "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" }, @@ -597568,10 +597649,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -597602,17 +597679,23 @@ "content": { "application/json": { "schema": { - "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" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -597629,7 +597712,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -597644,38 +597727,41 @@ }, "properties": { "data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -597691,25 +597777,25 @@ ] }, "azure_detail": { - "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" }, @@ -597725,7 +597811,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -597733,17 +597819,17 @@ "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" } @@ -597796,11 +597882,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -597810,10 +597899,6 @@ "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", @@ -597823,24 +597908,26 @@ }, "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": { - "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": { - "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": { @@ -597868,7 +597955,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -597908,29 +597995,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -598065,7 +598159,7 @@ "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, @@ -598183,7 +598277,7 @@ "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, @@ -598197,17 +598291,23 @@ "content": { "application/json": { "schema": { - "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" + "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": "", + "last_updated_by": "00000000-0000-0000-0000-000000000000", "row_count": 5, "schema": { "fields": [ @@ -598224,7 +598324,7 @@ "id" ] }, - "source": "LOCAL_FILE", + "source": "S3", "status": "DONE", "table_name": "test_reference_table", "tags": [ @@ -598239,38 +598339,41 @@ }, "properties": { "data": { - "description": "The definition of `TableResultV2Data` object.", + "additionalProperties": false, + "description": "The data object containing the reference table configuration and state.", "properties": { "attributes": { - "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": { - "description": "The definition of `TableResultV2DataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "description": "File metadata for reference tables created by cloud storage.", "properties": { "access_details": { - "description": "The definition of `TableResultV2DataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -598286,25 +598389,25 @@ ] }, "azure_detail": { - "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" }, @@ -598320,7 +598423,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -598328,17 +598431,17 @@ "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" } @@ -598391,11 +598494,14 @@ "type": "boolean" } }, + "required": [ + "access_details" + ], "title": "CloudFileMetadataV2", "type": "object" }, { - "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.", @@ -598405,10 +598511,6 @@ "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", @@ -598418,24 +598520,26 @@ }, "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": { - "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": { - "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": { @@ -598463,7 +598567,7 @@ "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.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -598503,29 +598607,36 @@ ] }, "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" }, "id": { - "description": "The ID of the reference table.", + "description": "Unique identifier for the reference table.", "type": "string" }, "type": { @@ -598658,7 +598769,7 @@ "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, @@ -598671,7 +598782,7 @@ "content": { "application/json": { "schema": { - "description": "The definition of `PatchTableRequest` object.", + "description": "Request body for updating an existing reference table.", "example": { "data": { "attributes": { @@ -598706,41 +598817,42 @@ "test_tag" ] }, - "id": "00000000-0000-0000-0000-000000000000", "type": "reference_table" } }, "properties": { "data": { - "description": "The definition of `PatchTableRequestData` object.", + "additionalProperties": false, + "description": "The data object containing the partial table definition updates.", "properties": { "attributes": { - "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": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadata` object.", + "description": "Metadata specifying where and how to access the reference table's data file.", "oneOf": [ { "additionalProperties": false, "description": "Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.", "properties": { "access_details": { - "description": "The definition of `PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.", + "description": "Cloud storage access configuration for the reference table data file.", "properties": { "aws_detail": { - "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" }, @@ -598756,25 +598868,25 @@ ] }, "azure_detail": { - "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" }, @@ -598790,7 +598902,7 @@ ] }, "gcp_detail": { - "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 file.", @@ -598798,17 +598910,17 @@ "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" } @@ -598836,7 +598948,7 @@ "properties": { "upload_id": { "description": "The upload ID.", - "example": "", + "example": "00000000-0000-0000-0000-000000000000", "type": "string" } }, @@ -598849,16 +598961,16 @@ ] }, "schema": { - "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": { - "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": { @@ -598884,9 +598996,9 @@ "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.", + "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. Primary keys cannot be changed after table creation.", "example": [ - "" + "field_1" ], "items": { "type": "string" @@ -598902,10 +599014,15 @@ }, "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" }, @@ -598914,10 +599031,6 @@ }, "type": "object" }, - "id": { - "description": "The ID of the reference table.", - "type": "string" - }, "type": { "default": "reference_table", "description": "Reference table resource type.", @@ -599054,7 +599167,7 @@ "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", @@ -599086,26 +599199,27 @@ "content": { "application/json": { "schema": { - "description": "The definition of `TableRowResourceArray` object.", + "description": "List of rows from a reference table query.", "properties": { "data": { "description": "The rows.", "items": { - "description": "The definition of `TableRowResourceData` object.", + "additionalProperties": false, + "description": "The data object containing the row column names and values.", "properties": { "attributes": { - "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" }, "id": { - "description": "The ID of the row.", + "description": "Row identifier, corresponding to the primary key value.", "type": "string" }, "type": { @@ -599247,18 +599361,20 @@ "content": { "application/json": { "schema": { - "description": "The definition of `CreateUploadRequest` object.", + "description": "Request to create an upload for a file to be ingested into a reference table.", "properties": { "data": { - "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": { - "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" @@ -599266,20 +599382,20 @@ "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" } @@ -599292,10 +599408,6 @@ ], "type": "object" }, - "id": { - "description": "The ID of the upload.", - "type": "string" - }, "type": { "default": "upload", "description": "Upload resource type.", @@ -599326,16 +599438,17 @@ "content": { "application/json": { "schema": { - "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": { - "description": "The definition of `CreateUploadResponseData` object.", + "additionalProperties": false, + "description": "Upload ID and attributes of the created upload.", "properties": { "attributes": { - "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" }, @@ -599345,7 +599458,7 @@ "type": "object" }, "id": { - "description": "The ID of the upload.", + "description": "Unique identifier for this upload. Use this ID when creating the reference table.", "type": "string" }, "type": {