feat(docs): autogenerate API documentation #27573
Draft
+3,602
−447
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
documentation
Missing ChangesetsThe following package(s) are changed by this PR but do not have a changeset:
See CONTRIBUTING.md for more information about how to add changesets. Changed Packages
|
aramissennyeydd
force-pushed
the
sennyeya/docsite-openapi
branch
from
156c510 to
ae114a7
Compare
4 tasks
|
Thanks for the contribution! |
awanlin
reviewed
Nov 22, 2024
There was a problem hiding this comment.
This looks like a great addition to the docs @aramissennyeydd, thanks for taking this on!
Looks good over all, curious about two things:
- Whats the impact on build time?
- Do we need to manage the new sidebars manually?
aramissennyeydd
force-pushed
the
sennyeya/docsite-openapi
branch
from
704463a to
8e11767
Compare
Signed-off-by: aramissennyeydd <[email protected]>
aramissennyeydd
force-pushed
the
sennyeya/docsite-openapi
branch
from
33328cd to
8954557
Compare
Signed-off-by: aramissennyeydd <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey, I just made a Pull Request!
Addresses #26894.
This uses https://github.com/PaloAltoNetworks/docusaurus-openapi-docs to render our existing specs. The goal here is to make the OpenAPI spec the source of truth for docs + API definition. I moved the existing catalog docs into the spec and saw really nice results in the autogenerated markdown.
TODO:
✔️ Checklist
Signed-off-byline in the message. (more info)