Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc:openapi Improve documentation on spec's nodeId #2084

Merged
merged 2 commits into from
Aug 23, 2022
Merged

doc:openapi Improve documentation on spec's nodeId #2084

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e202d3
This PR is for https://github.com/MarquezProject/marquez/issues/2083
howardyoo Aug 23, 2022
f70ada4
fixed the example part of the nodId
howardyoo Aug 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions spec/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -696,8 +696,10 @@ components:
in: query
schema:
type: string
example: dataset:food_delivery:public.delivery_7_days
description: The ID of the node.
example: dataset:food_delivery:public.delivery_7_days or job:my-namespace:my-job
howardyoo marked this conversation as resolved.
Show resolved Hide resolved
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
`job:<namespace_of_the_job>:<name_of_the_job>`.
required: true

depth:
Expand Down Expand Up @@ -1768,8 +1770,10 @@ components:
example: food_delivery
nodeId:
type: string
description: The ID of the dataset or job node.
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
`job:<namespace_of_the_job>:<name_of_the_job>`.
example: 'dataset:food_delivery:public.delivery_7_days'

SearchResultType:
type: enum
Expand Down