redoc
redoc copied to clipboard
Redocly
Public label
Describe the problem to be solved I'm working on https://docs.dojo.tech/payments/api#tag/Customers. The next set of APIs will have one public url for each method (in staging still), so there is no differentiating factor except the url. The GET / POST methods will be exactly the same on the left panel, like duplicated.
Describe the solution you'd like A label to show that this method is Public to clarify the duplicated methods.
Describe alternatives you've considered Trying to edit the current CSS or tried adding a star to the public method. But that looks off.
Additional context
In this image, I need to differentiate between the methods. One of them is public. It'd be great to have a label.
Maybe we should combine it with the x-badges proposal: https://github.com/Redocly/redoc/pull/1947
There are options here, but it would need tool changes. OpenAPI uses tags for applying labels to endpoints but we use those for navigation, which makes it hard to use the feature for anything else. The best workaround available today I think is to give different API endpoints different summaries, even if it's a "(public)" suffix, so that they can be seen in the navigation.
This workaround is temporary but we still require a solution because this causes duplication in the side menu. Will this be picked up anytime soon?
@monica-m-ps I don't have a timescale on this, but we'll keep the issue updated if there are updates.
@lornajane any update here? I initially submitted this #1399 and then a pull request was opened to support this. Now there is discussion on this being picked up by your team. Will this be a part of community?
Can you point me to the discussion you mean? I don't have any updates - these will be added to this issue when we have something.
The x-badges proposal already covers this case. There is more conversation and context in #1399. I think we should close this one and move the discussion to #1399.
