Redocly / Redocly/redoc

Public label

Open
#2,398 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue points to the Customers API reference at docs.dojo.tech/payments/api#tag/Customers and its duplicated GET/POST methods. Start by tracing how those methods are rendered in the API reference UI; done means a Public label clearly distinguishes the public method without relying on CSS or a star.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.