Create OpenAPI spec for Helioviewer & generate docs from spec#502
Merged
dgarciabriseno merged 14 commits intoJun 26, 2026
Conversation
added 14 commits
June 26, 2026 13:18
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
1 participant
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.
Moves hand written doc information into openapi.yml and generate the docs from spec.
Since the spec is auto-generated, we lose some of the old nicer looking format, but we can now also have a Swagger UI.
We're preserving the Read The Docs theme so we can also add in our own extra information in the appendix like Source IDs and other Helioviewer specific info that's not necessarily API specific.