Docs: Adds Redocusaurus OpenAPI plugin for Pomerium Zero API #661
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 pomerium-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
TODO: Merge |
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 adds the Redocusaurus plugin to
docusaurus.config.js, and adds a new/docusaurus-plugins/directory that stores a custom plugin that fixes anode_modulesissue with thedebugdependency. Without the custom plugin, the build will fail every time. (An example of this fix can be found here. )This PR adds a sample Pomerium Zero API spec using the Petstore example found here.
You can access the API reference from the NavBar, or by entering
/docs/api/in the URL path.