Provide option to display readOnly properties
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
When I mark a property in a request body with readOnly: true, redoc-cli doesn't display the property at all in the HTML output. This is at odds with the behavior of other documentation generators, which display the property with distinctive treatment that shows that the property is read-only. SwaggerHub is an example of this.
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 reproducing the issue in redoc-cli with a request-body property marked readOnly: true and inspect the generated HTML output. Compare the result with the expected distinctive read-only treatment; the work is done when the property is displayed and its read-only status is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, 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