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

Public label #2398

Open
monica-m-ps opened this issue Aug 30, 2023 · 8 comments
Open

Public label #2398

monica-m-ps opened this issue Aug 30, 2023 · 8 comments

Comments

@monica-m-ps
Copy link

monica-m-ps commented Aug 30, 2023

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
image

In this image, I need to differentiate between the methods. One of them is public. It'd be great to have a label.

@RomanHotsiy
Copy link
Member

Maybe we should combine it with the x-badges proposal: #1947

@lornajane
Copy link
Contributor

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.

@monica-m-ps
Copy link
Author

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?

@lornajane
Copy link
Contributor

@monica-m-ps I don't have a timescale on this, but we'll keep the issue updated if there are updates.

@JSSAggie
Copy link

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

@lornajane
Copy link
Contributor

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.

@adamaltman
Copy link
Member

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.

@deeepakmishrayap
Copy link

What's the latest update on this proposal ? Is it canned ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants