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

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

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

.generator/schemas/v2/openapi.yaml

@@ -17,7 +17,11 @@ import (
 type ReferenceTablesApi datadog.Service
 
 // CreateReferenceTable Create reference table.
-// Create a new reference table. You can provide data in two ways: 1) Call POST api/v2/reference-tables/upload first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this POST endpoint with the upload_id in file_metadata, OR 2) Provide access_details in file_metadata pointing to a CSV file in cloud storage (Amazon S3, Azure Blob Storage, or GCP Cloud Storage).
+// Creates a reference table. You can provide data in two ways:
+//  1. Call POST /api/v2/reference-tables/upload to get an upload ID. Then, PUT the CSV data
+//     (not the file itself) in chunks to each URL in the request body. Finally, call this
+//     POST endpoint with `upload_id` in `file_metadata`.
+//  2. Provide `access_details` in `file_metadata` pointing to a CSV file in cloud storage.
 func (a *ReferenceTablesApi) CreateReferenceTable(ctx _context.Context, body CreateTableRequest) (TableResultV2, *_nethttp.Response, error) {
 	var (
 		localVarHTTPMethod  = _nethttp.MethodPost

api/datadogV2/api_reference_tables.go

@@ -8,9 +8,9 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequest The definition of `CreateTableRequest` object.
+// CreateTableRequest Request body for creating a new reference table from a local file or cloud storage.
 type CreateTableRequest struct {
-	// The definition of `CreateTableRequestData` object.
+	// The data object containing the table definition.
 	Data *CreateTableRequestData `json:"data,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_create_table_request.go

@@ -10,17 +10,14 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequestData The definition of `CreateTableRequestData` object.
+// CreateTableRequestData The data object containing the table definition.
 type CreateTableRequestData struct {
-	// The definition of `CreateTableRequestDataAttributes` object.
+	// Attributes that define the reference table's configuration and properties.
 	Attributes *CreateTableRequestDataAttributes `json:"attributes,omitempty"`
-	// The ID of the reference table.
-	Id *string `json:"id,omitempty"`
 	// Reference table resource type.
 	Type CreateTableRequestDataType `json:"type"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
-	UnparsedObject       map[string]interface{} `json:"-"`
-	AdditionalProperties map[string]interface{} `json:"-"`
+	UnparsedObject map[string]interface{} `json:"-"`
 }
 
 // NewCreateTableRequestData instantiates a new CreateTableRequestData object.
@@ -71,34 +68,6 @@ func (o *CreateTableRequestData) SetAttributes(v CreateTableRequestDataAttribute
 	o.Attributes = &v
 }
 
-// GetId returns the Id field value if set, zero value otherwise.
-func (o *CreateTableRequestData) GetId() string {
-	if o == nil || o.Id == nil {
-		var ret string
-		return ret
-	}
-	return *o.Id
-}
-
-// GetIdOk returns a tuple with the Id field value if set, nil otherwise
-// and a boolean to check if the value has been set.
-func (o *CreateTableRequestData) GetIdOk() (*string, bool) {
-	if o == nil || o.Id == nil {
-		return nil, false
-	}
-	return o.Id, true
-}
-
-// HasId returns a boolean if a field has been set.
-func (o *CreateTableRequestData) HasId() bool {
-	return o != nil && o.Id != nil
-}
-
-// SetId gets a reference to the given string and assigns it to the Id field.
-func (o *CreateTableRequestData) SetId(v string) {
-	o.Id = &v
-}
-
 // GetType returns the Type field value.
 func (o *CreateTableRequestData) GetType() CreateTableRequestDataType {
 	if o == nil {
@@ -131,22 +100,14 @@ func (o CreateTableRequestData) MarshalJSON() ([]byte, error) {
 	if o.Attributes != nil {
 		toSerialize["attributes"] = o.Attributes
 	}
-	if o.Id != nil {
-		toSerialize["id"] = o.Id
-	}
 	toSerialize["type"] = o.Type
-
-	for key, value := range o.AdditionalProperties {
-		toSerialize[key] = value
-	}
 	return datadog.Marshal(toSerialize)
 }
 
 // UnmarshalJSON deserializes the given payload.
 func (o *CreateTableRequestData) UnmarshalJSON(bytes []byte) (err error) {
 	all := struct {
 		Attributes *CreateTableRequestDataAttributes `json:"attributes,omitempty"`
-		Id         *string                           `json:"id,omitempty"`
 		Type       *CreateTableRequestDataType       `json:"type"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
@@ -155,29 +116,18 @@ func (o *CreateTableRequestData) UnmarshalJSON(bytes []byte) (err error) {
 	if all.Type == nil {
 		return fmt.Errorf("required field type missing")
 	}
-	additionalProperties := make(map[string]interface{})
-	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
-		datadog.DeleteKeys(additionalProperties, &[]string{"attributes", "id", "type"})
-	} else {
-		return err
-	}
 
 	hasInvalidField := false
 	if all.Attributes != nil && all.Attributes.UnparsedObject != nil && o.UnparsedObject == nil {
 		hasInvalidField = true
 	}
 	o.Attributes = all.Attributes
-	o.Id = all.Id
 	if !all.Type.IsValid() {
 		hasInvalidField = true
 	} else {
 		o.Type = *all.Type
 	}
 
-	if len(additionalProperties) > 0 {
-		o.AdditionalProperties = additionalProperties
-	}
-
 	if hasInvalidField {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
 	}

api/datadogV2/model_create_table_request_data.go

@@ -10,19 +10,19 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequestDataAttributes The definition of `CreateTableRequestDataAttributes` object.
+// CreateTableRequestDataAttributes Attributes that define the reference table's configuration and properties.
 type CreateTableRequestDataAttributes struct {
-	// The description of the reference table.
+	// Optional text describing the purpose or contents of this reference table.
 	Description *string `json:"description,omitempty"`
-	// The definition of `CreateTableRequestDataAttributesFileMetadata` object.
+	// Metadata specifying where and how to access the reference table's data file.
 	FileMetadata *CreateTableRequestDataAttributesFileMetadata `json:"file_metadata,omitempty"`
-	// The definition of `CreateTableRequestDataAttributesSchema` object.
+	// Schema defining the structure and columns of the reference table.
 	Schema CreateTableRequestDataAttributesSchema `json:"schema"`
 	// The source type for creating reference table data. Only these source types can be created through this API.
 	Source ReferenceTableCreateSourceType `json:"source"`
-	// The name of the reference table.
+	// Name to identify this reference table.
 	TableName string `json:"table_name"`
-	// The tags of the reference table.
+	// Tags for organizing and filtering reference tables.
 	Tags []string `json:"tags,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_create_table_request_data_attributes.go

@@ -8,7 +8,7 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequestDataAttributesFileMetadata - The definition of `CreateTableRequestDataAttributesFileMetadata` object.
+// CreateTableRequestDataAttributesFileMetadata - Metadata specifying where and how to access the reference table's data file.
 type CreateTableRequestDataAttributesFileMetadata struct {
 	CreateTableRequestDataAttributesFileMetadataCloudStorage *CreateTableRequestDataAttributesFileMetadataCloudStorage
 	CreateTableRequestDataAttributesFileMetadataLocalFile    *CreateTableRequestDataAttributesFileMetadataLocalFile

api/datadogV2/model_create_table_request_data_attributes_file_metadata.go

@@ -12,7 +12,7 @@ import (
 
 // CreateTableRequestDataAttributesFileMetadataCloudStorage Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.
 type CreateTableRequestDataAttributesFileMetadataCloudStorage struct {
-	// The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.
+	// Cloud storage access configuration for the reference table data file.
 	AccessDetails CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails `json:"access_details"`
 	// Whether this table is synced automatically.
 	SyncEnabled bool `json:"sync_enabled"`

api/datadogV2/model_create_table_request_data_attributes_file_metadata_cloud_storage.go

@@ -8,13 +8,13 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails` object.
+// CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails Cloud storage access configuration for the reference table data file.
 type CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails struct {
-	// The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object.
+	// Amazon Web Services S3 storage access configuration.
 	AwsDetail *CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail `json:"aws_detail,omitempty"`
-	// The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object.
+	// Azure Blob Storage access configuration.
 	AzureDetail *CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail `json:"azure_detail,omitempty"`
-	// The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail` object.
+	// Google Cloud Platform storage access configuration.
 	GcpDetail *CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail `json:"gcp_detail,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_create_table_request_data_attributes_file_metadata_one_of_access_details.go

@@ -10,11 +10,11 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail` object.
+// CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail Amazon Web Services S3 storage access configuration.
 type CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail struct {
-	// The ID of the AWS account.
+	// AWS account ID where the S3 bucket is located.
 	AwsAccountId string `json:"aws_account_id"`
-	// The name of the Amazon S3 bucket.
+	// S3 bucket containing the CSV file.
 	AwsBucketName string `json:"aws_bucket_name"`
 	// The relative file path from the S3 bucket root to the CSV file.
 	FilePath string `json:"file_path"`

api/datadogV2/model_create_table_request_data_attributes_file_metadata_one_of_access_details_aws_detail.go

@@ -10,15 +10,15 @@ import (
 	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
 )
 
-// CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail The definition of `CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail` object.
+// CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail Azure Blob Storage access configuration.
 type CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail struct {
-	// The Azure client ID.
+	// Azure service principal (application) client ID with permissions to read from the container.
 	AzureClientId string `json:"azure_client_id"`
-	// The name of the Azure container.
+	// Azure Blob Storage container containing the CSV file.
 	AzureContainerName string `json:"azure_container_name"`
-	// The name of the Azure storage account.
+	// Azure storage account where the container is located.
 	AzureStorageAccountName string `json:"azure_storage_account_name"`
-	// The ID of the Azure tenant.
+	// Azure Active Directory tenant ID.
 	AzureTenantId string `json:"azure_tenant_id"`
 	// The relative file path from the Azure container root to the CSV file.
 	FilePath string `json:"file_path"`