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.

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

Conversation

howardyoo
Copy link
Collaborator

Signed-off-by: howardyoo howardyoo@gmail.com

Problem

The current spec description lacks complete examples of the format and example of nodeId.

Closes: #2083

Solution

  • added more example and details on what nodeId.
  • updated description of the nodeId.

Note: All database schema changes require discussion. Please link the issue for context.

Checklist

  • You've signed-off your work
  • Your changes are accompanied by tests (if relevant)
  • Your change contains a small diff and is self-contained
  • You've updated any relevant documentation (if relevant)
  • You've updated the CHANGELOG.md with details about your change under the "Unreleased" section (if relevant, depending on the change, this may not be necessary)
  • You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • You've included a header in any source code files (if relevant)

- adds more example and details on what nodeId.
- updated description of the nodeId.

Signed-off-by: howardyoo <howardyoo@gmail.com>
@howardyoo howardyoo changed the title This PR is for https://github.com/MarquezProject/marquez/issues/2083 doc:openapi Improve documentation on spec's nodeId Aug 23, 2022
@codecov
Copy link

codecov bot commented Aug 23, 2022

Codecov Report

Merging #2084 (f70ada4) into main (95d6de5) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main    #2084   +/-   ##
=========================================
  Coverage     77.04%   77.04%           
  Complexity     1013     1013           
=========================================
  Files           201      201           
  Lines          4643     4643           
  Branches        389      389           
=========================================
  Hits           3577     3577           
  Misses          628      628           
  Partials        438      438           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

spec/openapi.yml Outdated Show resolved Hide resolved
Signed-off-by: howardyoo <howardyoo@gmail.com>
Copy link
Member

@wslulciuc wslulciuc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@wslulciuc wslulciuc merged commit 7da23da into MarquezProject:main Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation on nodeId
2 participants