-
Notifications
You must be signed in to change notification settings - Fork 80
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
feat: better openapi docs #1300
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request is neither linked to an issue or epic nor labeled as adhoc!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request is neither linked to an issue or epic nor labeled as adhoc!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request is neither linked to an issue or epic nor labeled as adhoc!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request is neither linked to an issue or epic nor labeled as adhoc!
I took a look and I think the easiest way will be to just exclude /source/api from mdlint, vale & typos |
That's exactly what I am trying to do, it works for typos, still battling with the other two. |
4b0b2c7
to
6c695c7
Compare
This PR overhauls our OpenAPI setup completely:
apify-api
folder)npm start
will generate the specs as well as produce the MDX files out of themnpm run api:rebuild
will rebuild the yaml spec file and recreate the MDX filesfaster
mode (rust based tooling)Things to discuss:
index page now only redirects, maybe we should move the content from the introduction section (so outside of OpenAPI specs)folder structure