Add Swagger UI to Internal Endpoints page #1347
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
|
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1347.surge.sh 🎊 |
viren-nadkarni
force-pushed
the
public-api-schema
branch
from
a953e74 to
e28d4ee
Compare
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.
Caution
Reviewers please do not merge
Background
The 'Internal Enpoints' page which documented the LocalStack public REST API was incomplete and unmaintained. We are adding OpenAPI support to LocalStack. The OpenAPI spec will be used in docs to render a Swagger UI within the page.
Changes
The embedded Swagger UI contains comprehensive description of the REST API endpoints, operations and schema.
It can also be used for live interaction with LocalStack API right from the docs page.
⚡ Preview Here ⚡
Related
https://spec.openapis.org/oas/latest.html