Update table descriptions

To return an accurate response set descriptions or update the columns per table and column. All request body fields are optional, and only the fields that are explicitly set will be used to update the resource.

Request this PATCH endpoint:

/api/v1/table-descriptions/{table_description_id}

Parameters

Name	Type	Description
table_description_id	String	Table description id, Required

Request body

{
  "description": "string", # Optional
  "columns": [ # Optional
    {
      "name": "string", # Optional
      "description": "string", # Optional
      "is_primary_key": false, # Optional
      "data_type": "string", # Optional
      "low_cardinality": true, # Optional
      "categories": [ # Optional
        "string"
      ],
      "foreign_key": false # Optional
    }
  ]
}

Responses

HTTP 200 code response

{
  "id": "string",
  "db_connection_id": "string",
  "table_name": "string",
  "description": "string",
  "table_schema": "string",
  "columns": [
    {
      "name": "string",
      "is_primary_key": false,
      "data_type": "str",
      "description": "string",
      "low_cardinality": false,
      "categories": [
        "string"
      ],
      "foreign_key": {
        "field_name": "string",
        "reference_table": "string"
      }
    }
  ],
  "examples": []
}

Example 1

Only set a table description

 curl -X 'PATCH' \
'<host>/api/v1/table-descriptions/64fa09446cec0b4ff60d3ae3' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
      "description": "Only set a table description"
  }'

Example 2

Only set columns descriptions

 curl -X 'PATCH' \
'<host>/api/v1/table-descriptions/64fa09446cec0b4ff60d3ae3' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "columns": [
      {
        "name": "column1",
        "description": "Set column1 description"
      },
      {
        "name": "column2",
        "description": "Set column2 description"
      }
    ]
  }'