elements icon indicating copy to clipboard operation
elements copied to clipboard

Add support for custom badges

Open manvydasu opened this issue 2 years ago • 2 comments

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.

manvydasu avatar Nov 21 '23 07:11 manvydasu

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?

ryotrellim avatar Dec 01 '23 17:12 ryotrellim

@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.

manvydasu avatar Dec 06 '23 17:12 manvydasu