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

Add support for custom badges #2457

Open
manvydasu opened this issue Nov 21, 2023 · 2 comments
Open

Add support for custom badges #2457

manvydasu opened this issue Nov 21, 2023 · 2 comments
Labels
enhancement New feature or request triaged

Comments

@manvydasu
Copy link

manvydasu commented Nov 21, 2023

Currently, stoplight supports "Deprecated" and "Internal" badges near the title of endpoint. It would be nice to add support of custom badges, i.e. "Preview", or "Beta", or something similar.

Context

Trying to render a custom badge near endpoint name.

Current Behavior

Only hardcoded set amount of badges is supported.

Expected Behavior

I'd expect to be able to provide "x-preview" extension on the Open API spec and see "Preview" badge near the endpoint. Bonus points, if text can be controlled.

@chohmann chohmann added enhancement New feature or request triaged labels Dec 1, 2023
@ryotrellim
Copy link
Contributor

Hello @manvydasu! I appreciate the feature request.

Quick follow-up question: Is your use case primarily communicating lifecycles or "stages" in the UI, or are there other ideas you're trying to inject into the UI?

@manvydasu
Copy link
Author

@ryotrellim
Hello,

Yes, in a way I would like to communicate extra information in the UI.
Lets say I'd like to indicate, that a particular endpoint is in beta version and breaking changes might be introduced unexpectedly for it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triaged
Projects
None yet
Development

No branches or pull requests

3 participants