Add OpenAPI spec with Swagger UI to API reference#14
Open
gaarutyunov wants to merge 1 commit intoslicervm:masterfrom
Open
Add OpenAPI spec with Swagger UI to API reference#14gaarutyunov wants to merge 1 commit intoslicervm:masterfrom
gaarutyunov wants to merge 1 commit intoslicervm:masterfrom
Conversation
Signed-off-by: German Arutyunov <[email protected]>
Member
|
Hey @gaarutyunov just saw this.. we'll have a look at it soon. We also generated openapi definitions recently after some changes and additional endpoints. Alex |
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
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.
Description
Add interactive OpenAPI documentation to the API reference page using Swagger UI. This replaces the manual markdown endpoint documentation with a machine-readable OpenAPI 3.0 specification rendered via the mkdocs-swagger-ui-tag plugin.
Changes include:
docs/reference/openapi.yaml- Complete OpenAPI 3.0 spec covering all REST API endpointsdocs/reference/api.md- Updated to embed Swagger UI widgetdocs/assets/swagger-hide-models.css- CSS to hide redundant info header in Swagger UImkdocs.yml- Added swagger-ui-tag plugin configurationrequirements.txt- Added mkdocs-swagger-ui-tag dependencyMotivation and Context
The current API documentation is manually maintained in markdown, which can become outdated and doesn't provide interactive features. An OpenAPI spec enables:
Interactive "Try it out" functionality
Auto-generated client SDKs
Better schema documentation
Easier maintenance
I have raised an issue to propose this change (required)
How Has This Been Tested?
Tested locally using
mkdocs serve- verified Swagger UI renders correctly and all endpoints are documented.Types of changes
Checklist:
git commit -s