x-badges support

[mm-gmbd]

What/Why/How?

Support for x-badges, discussed as a potential solution for https://github.com/Redocly/redoc/issues/1399.

Current PR status is:

• test implementation of what the badges would look like for the operation.
• I haven't updated the side-menu
  • not sure if that should actually be included as I'm not sure how it could be done cleanly)
• no tests yet
• no documentation yet
• just looking for input on the approach and whether or not redoc would be interesting in this functionality being supported

Reference

https://github.com/Redocly/redoc/issues/1399

Testing

No tests yet, in draft.

Screenshots (optional)

Check yourself

• [ not_yet ] Code is linted
• [ not_yet ] Tested
• [ not_yet ] All new/updated code is covered with tests

[mm-gmbd]

+bump. Would love to get some input on the direction and whether or not redoc is interested in pulling this in. Currently using a custom fork but would like to be back on the main branch 🥲

[cmeeren]

Would love to have this. But I need it for schema properties, too, not just operations. For example, if a property is experimental.

[FabianCorpBC]

Is this pr still getting considered? We currently use redocly and wanted a way to capture the state of our apis. And will the badges be customizable? We wanted to have badges like 'Preview, Released, Stable, etc.' along with the ones you've included in src/types/open-api.ts

[fgblomqvist]

Is there an official response to this? @RomanHotsiy? It's a shame that it's just sitting here since there are plenty of people requesting it and you have people willing to do the work.

[RomanHotsiy]

Hey there. I somehow missed this PR and all the notifications 🙈.

I think this is a valid idea. We'll take it into our short-term backlog. We have some feedback to the configuration but overall looks good.

cc @AlexVarchuk, let's talk about it when you have time this week.

[monica-m-ps]

Hey team. Is this still under consideration? Do we have a workaround until then?

[monica-m-ps]

Will this be picked up sooner?

[lornajane]

I'm closing this pull request because we're discussing the feature internally now and we don't feel that this covers everything that's needed. We already have some discussion active under https://github.com/Redocly/redoc/issues/2398, so please add your requests, comments and questions over there and we'll keep you posted by updating that issue.

And most importantly, thank you @mm-gmbd for opening the pull request in the first place. We didn't merge but it helped us get the conversation moving!