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

Add “offline” spec validations in the validate command (optional flag) #5

Open
paulRbr opened this issue Apr 8, 2021 · 3 comments
Labels
enhancement New feature or request

Comments

@paulRbr
Copy link
Member

paulRbr commented Apr 8, 2021

When using the bump validate command it could make sense to add a --strict flag to enable OpenAPI/AsyncAPI spec verification.

@paulRbr
Copy link
Member Author

paulRbr commented May 3, 2023

We should probably use https://github.com/stoplightio/spectral to delegate validation to the formal specs directly

@philsturgeon
Copy link

Spectral certainly has more rulesets built already, but Redocly CLI has an interesting approach which is easier to work with. Preview of a post I've done on the tool showing off a bit of the linting. https://apisyouwonthate.com/p/9cee6154-f443-4c4c-8163-b76be3c55d3f/

@philsturgeon
Copy link

Remember there's more than just "linting YAML" or "linting OpenAPI", using some of these rulesets moves you into API Security testing and compliance.

https://github.com/stoplightio/spectral-rulesets

And you move into API Governance if custom rulesets are being used:

https://apisyouwonthate.com/blog/automated-style-guides-for-rest-graphql-grpc/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants