Skip to content

Improve documentation on nodeId #2083

@howardyoo

Description

@howardyoo

Problem

If you look at the marquez' API documentation such as this: https://marquezproject.github.io/marquez/openapi.html#operation/recordLineage, you would notice the node ID is explained without much details:

Example: nodeId=dataset:food_delivery:public.delivery_7_daysThe ID of the node.

Because of this, users would typically get confused on what the nodeId should be.

Solution

Add more details like this for nodeId:

The format for the nodeId= parameter for that one is :
job:<namespace_of_the_job>:<name_of_the_job>  or
dataset:<namespace_of_dataset>:<name_of_the_dataset>

So that users would know how to better formulate nodeId.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions