Redocly / Redocly/redoc

Duplicate use of tags screws up navigation

Open
#777 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I use it on open api 3 spec.

I have multiple api operations with double (or more) tags.

When i click on one though the ReDoc Viewer, it automatically moves the navigation to the top most tag in the navigation.

Say: Tag1,Tag2

operation A has tag 1 and 2.

  • i navigate Tag2 => Operation A
  • Now in the menu i'm navigated to: Tag1 => Operation A.

This is very annoying.

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

Reproduce the issue in the ReDoc Viewer with an OpenAPI 3 operation that has multiple tags, such as Tag1 and Tag2. Start by tracing the navigation selection behavior when choosing the operation under Tag2; done means the navigation remains on Tag2 instead of moving to Tag1.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
documentation, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.