API Docs: implement custom OpenAPI component #738
Closed
Conversation
This file contains hidden or 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
Previously, there was no easy way to reference docs for our REST API endpoints. This PR adds a new `<ApiOperation/>` React component that we can use in MDX files to embed docs for a single API operation. The component renders the code examples, request schema, and response schema using existing components like code blocks and HTML tables avoiding the need for custom CSS styling.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
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.
Previously, there was no easy way to reference docs for our REST API endpoints. This PR adds a new
<ApiOperation/>React component that we can use in MDX files to embed docs for a single API operation. The component renders the code examples, request schema, and response schema using existing components like code blocks and HTML tables avoiding the need for custom CSS styling.Pull Request approval
You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.