I'm using Redocly to generate API documentation and I would like to sync the `oneOf` tiles with the example payload dropdown in the generated UI. Currently, the two elements are not synchronized, and I'm seeking guidance on how to achieve this synchronization.
Open
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
Issue Description
Expected Behaviour:
When a user clicks on a oneOf tile, the corresponding option should be selected in the example payload dropdown, and vice versa.
Steps to Reproduce
- Generate API documentation using Redocly.
- Navigate to the section with
oneOftiles and the example payload dropdown. - Observe that the selection in the
oneOftiles and the example payload dropdown are not synchronized.
- Redocly Version: 3
Thank you!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the Redocly v3 generated UI code for the oneOf tiles and example payload dropdown, then trace how each control handles selection. Done means clicking either control selects the corresponding option in the other, with the behavior verified in the rendered API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100