Skip to content
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

[FEATURE] Add a Swagger playground where APIs can be invoked against #93

Closed
1 of 3 tasks
VachaShah opened this issue Apr 28, 2023 · 3 comments
Closed
1 of 3 tasks
Labels
enhancement New feature or request

Comments

@VachaShah
Copy link
Collaborator

VachaShah commented Apr 28, 2023

OpenSearch API specs publishing was setup in PR #75 and #76. Proposing some enhancements for the published specs:

  • Once we implement spec versioning, have an option for versioned specs [PROPOSAL] Publish versioned API specs #84
  • Implement the Try it out button to use a custom server link (localhost or a custom server endpoint)
  • Custom UI
@dblock
Copy link
Member

dblock commented May 1, 2023

I recommend doing at least minimum versioning earlier than later, i.e. publishing specs under a product and major version folder (e.g. OpenSearch/2.x).

@wbeckler wbeckler removed the untriaged label May 4, 2023
@dblock dblock changed the title [FEATURE] Improve published OpenAPI specs [FEATURE] Add a Swagger playground where APIs can be invoked against Apr 2, 2024
@dblock
Copy link
Member

dblock commented Apr 2, 2024

There's a good idea here to have a playground that lets you try an API, renamed.

@dblock
Copy link
Member

dblock commented Apr 3, 2024

Actually https://opensearch-project.github.io/opensearch-api-specification/ has a way to try APIs, but that doesn't work because there's no actual OpenSearch, I'll open a new bug on this.

@dblock dblock closed this as completed Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants