feat: generate API reference docs from OpenAPI spec #1526
Open
fabiovincenzi wants to merge 5 commits intofinos:mainfrom
Open
feat: generate API reference docs from OpenAPI spec #1526fabiovincenzi wants to merge 5 commits intofinos:mainfrom
fabiovincenzi wants to merge 5 commits intofinos:mainfrom
Conversation
✅ Deploy Preview for endearing-brigadeiros-63f9d0 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| const propResolved = resolveSchema(prop, spec); | ||
| const type = formatType(prop, spec); | ||
| const isRequired = required.has(name) ? '**Yes**' : 'No'; | ||
| const desc = (propResolved?.description || '').replace(/\|/g, '\\|'); |
| for (const param of params) { | ||
| const type = formatType(param.schema, spec); | ||
| const required = param.required ? '**Yes**' : 'No'; | ||
| const desc = (param.description || '').replace(/\|/g, '\\|'); |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 is based on #1501
scripts/doc-swagger.jsthat parsesdist/swagger.jsoninto MDX pages, following the same pattern as the existingscripts/doc-schema.jsCloses #1510