[WIP] Add swagger config #242
Closed
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
✅ Deploy Preview for harvester-preview ready!
|
Merged
|
@guangbochen Already updated the API titles and adjusted the sidebar. Please help take a look at the production build as mentioned before. Thanks! |
masteryyh
force-pushed
the
vk-dev
branch
3 times, most recently
from
e83e6a0
to
6954024
Compare
vickyhella
force-pushed
the
vk-dev
branch
3 times, most recently
from
778df62
to
f174b47
Compare
vickyhella
force-pushed
the
vk-dev
branch
2 times, most recently
from
0261ba6
to
b27b585
Compare
|
Closing in favor of #388 |
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.
This PR:
2.0.0-beta.3.2.4.118.2.0docusaurus.config.jsfileRelated issue:
What needs to be done:
Modify
api/petstore.yamlanddocusaurus.config.jsbased on our actual needs (see the plugin documentation for more info). Note that the currentapi/petstore.yamlfile is an example file for reference only.Run
yarn docusaurus gen-api-docs all, which generates MDX files in thedocs/apifolder.It'll be better if we can split the yaml file into several files by category, because the plugin actually generates one page for each API, which might be hard to read as we have hundreds of APIs.
References
docusaurus.config.jsconfig: https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/demo/docusaurus.config.js