Redocly/redoc

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

Open

#991 geöffnet am 31. Juli 2019

Auf GitHub ansehen
 (12 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (21.877 Stars) (2.272 Forks)batch import
Type: Enhancementhelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
half day
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of ReactUnderstanding of Redoc component structureFamiliarity with OpenAPI spec properties
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30
Research-Richtung
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.