-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add OpenAPI v3 visualisation to docs #17
Merged
Merged
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
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
ndom91
changed the title
feat: add script to generate gitbutler v3 openapi docs
feat: add OpenAPI v3 visualisation to docs
Jul 27, 2024
Broken Link Checker
1) /api-reference
|
Can ignore the broken link checker for now, that file is newly added in this PR, therefore the autogenerated link to "edit this page on |
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.
☕️ Reasoning
🧢 Changes
scripts/generate-docs.mjs
script to fetch our swagger definition JSON and convert it from v2 to v3, using Swagger's first party conversion web service. Then, write that v3 swagger json to disk and pass it as input to the fumadocs fn which generates themdx
files that get displayed in the end.github.com/gitbutlerapp/gitbutler/releases
instead of attempting to maintain two separate lists.releases.mdx
related code📸 Screenshots
First Load:
OpenAPI Section: