document column lineage endpoint
@@ -569,6 +569,24 @@ paths:
schema:
$ref: '#/components/schemas/LineageGraph'
+ /column-lineage:
+ get:
+ operationId: getLineage
+ parameters:
+ - $ref: '#/components/parameters/nodeId'
+ - $ref: '#/components/parameters/depth'
+ - $ref: '#/components/parameters/withDownstream'
+ tags:
+ - Column lineage
+ summary: Get a column-lineage graph
+ responses:
+ '200':
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/LineageGraph'
+
/tags/{tag}:
parameters:
- $ref: '#/components/parameters/tag'
@@ -743,8 +761,9 @@ components:
schema:
type: string
example: dataset:food_delivery:public.delivery_7_days
- description: The ID of the node. A node can either be a dataset node or a job node. The format of
- nodeId for dataset is `dataset:<namespace_of_dataset>:<name_of_the_dataset>` and for job is
+ description: The ID of the node. A node can either be a dataset node, a dataset field node or a job node.
+ The format of nodeId for dataset is `dataset:<namespace_of_dataset>:<name_of_the_dataset>`, for dataset field
+ is `datasetField:<namespace_of_dataset>:<name_of_the_dataset>:<name_of_field>`, and for job is
`job:<namespace_of_the_job>:<name_of_the_job>`.
required: true
@@ -757,6 +776,15 @@ components:
description: Depth of lineage graph to create.
required: false
+ withDownstream:
+ name: withDownstream
+ in: query
+ schema:
+ type: boolean
+ default: false
+ description: Determines if downstream lineage should be returned.
+ required: false
+
q:
name: q
in: query
