docs icon indicating copy to clipboard operation
docs copied to clipboard

Add Swagger UI to Internal Endpoints page

Open viren-nadkarni opened this issue 1 year ago • 1 comments

[!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.

:zap: Preview Here :zap:

Related

https://spec.openapis.org/oas/latest.html

viren-nadkarni avatar Jun 27 '24 08:06 viren-nadkarni

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1347.surge.sh 🎊

github-actions[bot] avatar Jun 27 '24 08:06 github-actions[bot]