Add an option to hide deprecated parameters in Redoc
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
As an API documentation user and developer, I would like to have the ability to hide deprecated parameters in the Redoc-rendered documentation. This feature would provide an additional level of control over the display of deprecated parameters, making it easier for API consumers to focus on the most relevant and up-to-date parts of the API.
Proposed Solution:
Introduce a new configuration option, such as hideDeprecatedParameters, that controls the visibility of deprecated parameters in the Redoc-rendered documentation. This option could be set to true or false, with the default value being false to maintain backward compatibility.
hideDeprecatedParameters: true
This feature request aligns with Redoc's goal of providing a customizable and user-friendly API documentation experience. Implementing the ability to hide deprecated parameters would be a valuable addition to Redoc's already robust feature set, further enhancing its utility for both API consumers and developers.
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 by locating Redoc's configuration-option handling and the rendering path for API parameters, then inspect how deprecated parameters are currently displayed. Add the proposed hideDeprecatedParameters option with a default of false, and verify that true hides deprecated parameters while false preserves existing output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100