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

Jump to bottom

Open API specification document should be validated/linted #74

Open
carlwilson opened this issue Sep 6, 2023 · 0 comments
Open

Open API specification document should be validated/linted #74

carlwilson opened this issue Sep 6, 2023 · 0 comments

Comments

@carlwilson
Copy link
Member

The automated build currently does nothing to validate that the Open API specification documents: ./api/par-api.yaml is:

  • valid YAML;
  • a valid instance according to the Open API schema; and
  • is linted to ensure that best practise is followed, e.g. are the examples valid types?

Some of the above should be improved, there are a few tools available.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@carlwilson