Manage Data Asset Documentation

Use this route to create or update the documentation for a specific data asset.

How to use

Provide the data asset id as a path parameter and the asset_type as a query parameter. Send the documentation content in the request body.

Payload example

{
  "docs": "# Sales Data\n\nThis dataset contains quarterly sales figures broken down by region and product category."
}

Body fields

• docs: markdown-formatted documentation content for the data asset.

Query parameters

• asset_type: the type of asset to associate the documentation with.

Error scenarios