Redocly/redoc

Display read-only and write-only labels when using SchemaDefinition

Open

#991 opened on Jul 31, 2019

View on GitHub
 (12 comments) (0 reactions) (1 assignee)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Enhancementhelp wanted

Description

It's great to have the new SchemaDefinition! Thanks for all your hard work @nanov and @RomanHotsiy! 🙏

It would be fantastic to have it display "read-only" and "write-only" labels for relevant properties. Currently there is no way to signify that, except duplicating the information by writing it by hand in the property descriptions.

Contributor guide

Tech stack
typescriptreacthtmlcss
Domain
frontenddocumentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of ReactUnderstanding of Redoc component structureFamiliarity with OpenAPI spec properties
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by examining the SchemaDefinition component in the Redoc codebase, likely located in a file like `src/components/Schema/SchemaDefinition.tsx`. Look for how properties are rendered, and check if there are existing label patterns (e.g., 'required') that can be reused. The issue requests adding visual labels for read only and write only properties. Investigate the OpenAPI spec handling to see if 'readOnly' and 'writeOnly' fields are already accessible. Consider how to style these labels and ensure they integrate with the existing design. Check the issue comments for any prior discussion or attempts.