Redocly / Redocly/redoc

Show required scopes in route unexpanded authorizations section

Open
#2,180 1 comment 3 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
Currently, a route's required scopes are not shown in the Authorizations section unless it is expanded:
Unexpanded (default state):
image
Expanded:
image

Describe the solution you'd like
It would be great to be able to see at a glance a route's required scopes.
One solution would be showing them in the unexpanded state in brackets like in the expanded state.
Another solution is adding a config option to always expand the authorizations sections at page load.

Describe alternatives you've considered
We could put the required scopes in the route description but that's not really an elegant solution.

Additional context
We use OpenAPI version 3.1, Redoc latest (2.0.0 at this time).
We have a single security scheme of type http.

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

Start with the Redoc Authorizations section and trace how OpenAPI 3.1 security requirements are rendered in collapsed and expanded states. Decide with maintainers whether the display should show scopes by default or provide a configuration option, then verify that required scopes are visible at a glance without breaking the existing expanded view.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.