Redocly / Redocly/redoc

readOnly property is not marked in HTML

Open
#1,097 5 comments 0 reactions 0 assignees View on GitHub

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

Properties marked as readOnly are not visually marked as readOnly in HTML see:
image

example

packets:
    type: integer
    minimum: 0
    readOnly: true 

(also they are not present at all in the request, already reported here https://github.com/Redocly/redoc/issues/948)

tested on 2.0.rc14

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

Start by reproducing the issue with the provided packets schema and inspect how readOnly properties are rendered in the HTML documentation. Compare the rendered property with the request behavior tracked in issue 948; the work is done when readOnly properties are visibly marked in the HTML.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.