Skip to content

Commit 7da23da

Browse files
authored
doc:openapi Improve documentation on spec's nodeId (#2084)
* This PR is for #2083 - adds more example and details on what nodeId. - updated description of the nodeId. Signed-off-by: howardyoo <howardyoo@gmail.com> * fixed the example part of the nodId Signed-off-by: howardyoo <howardyoo@gmail.com> Signed-off-by: howardyoo <howardyoo@gmail.com>
1 parent 95d6de5 commit 7da23da

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

spec/openapi.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -697,7 +697,9 @@ components:
697697
schema:
698698
type: string
699699
example: dataset:food_delivery:public.delivery_7_days
700-
description: The ID of the node.
700+
description: The ID of the node. A node can either be a dataset node or a job node. The format of
701+
nodeId for dataset is `dataset:<namespace_of_dataset>:<name_of_the_dataset>` and for job is
702+
`job:<namespace_of_the_job>:<name_of_the_job>`.
701703
required: true
702704

703705
depth:
@@ -1768,8 +1770,10 @@ components:
17681770
example: food_delivery
17691771
nodeId:
17701772
type: string
1771-
description: The ID of the dataset or job node.
1772-
example: dataset:food_delivery:public.delivery_7_days
1773+
description: The ID of the node. A node can either be a dataset node or a job node. The format of
1774+
nodeId for dataset is `dataset:<namespace_of_dataset>:<name_of_the_dataset>` and for job is
1775+
`job:<namespace_of_the_job>:<name_of_the_job>`.
1776+
example: 'dataset:food_delivery:public.delivery_7_days'
17731777

17741778
SearchResultType:
17751779
type: enum

0 commit comments

Comments
 (0)