Callbacks should have id attributes to allow linking to them
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
There should be an ability to deep-link to a specific callback within the ReDoc documentation for an API. There are no id attributes associated with anything callback-related (neither the Callbacks heading, nor specific callback details).
Example document: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/callback-example.yaml
Describe the solution you'd like
id attributes generated by ReDoc for callbacks.
Preferably, navigating to the link with #id would also expand the callback section.
Describe alternatives you've considered
Text fragments — slow and don’t work in Firefox or Safari.
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
Use the linked ReDoc callback example as the reproduction case and inspect how callback documentation is rendered. Add stable id attributes for the Callbacks heading and individual callback details, then verify that a #id link reaches the callback and expands its section when applicable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100