Skip to main content
POST
Generate Database Description

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

source_id
string<uuid> | null
required
database_id
string<uuid>
required

Query Parameters

organization_id
string<uuid> | null
resource_id
string<uuid> | null
integration_source_id
string<uuid> | null
data_source_id
string<uuid> | null
context_source_id
string<uuid> | null
job_id
string<uuid> | null

Body

application/json

Request for single database description generation.

cascade_schemas
boolean
default:true

Generate missing schema/table/column descriptions first

overwrite_existing
boolean
default:false

Regenerate description even if one already exists

Response

Successful Response