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

[Bug] Update OpenAPI spec to be compliant #286

Open
matoszz opened this issue Dec 8, 2024 · 0 comments
Open

[Bug] Update OpenAPI spec to be compliant #286

matoszz opened this issue Dec 8, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@matoszz
Copy link
Contributor

matoszz commented Dec 8, 2024

I discovered several inconsistencies with our OpenAPI specification when trying to upload to our new docs site, but there are likely more. I made a first pass in this PR but the spec is still non-compliant for several reasons you can see by using openAPI spec linting tool.

I personally use vacuum; you can save / see the active openapi specification by doing something similar to:

curl https://api.theopenlane.io/api-docs > api.json

and then can run a linter against the spec such as:

vacuum lint api.json -d
@matoszz matoszz added the bug Something isn't working label Dec 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant