Redocly/redoc

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

Open

#991 aperta il 31 lug 2019

Vedi su GitHub
 (12 commenti) (0 reazioni) (1 assegnatario)TypeScript (2272 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (21.877 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Trova il componente SchemaDefinition, individua dove vengono renderizzati i nomi delle proprietà e aggiungi indicatori visivi per le proprietà readOnly e writeOnly.
Tech stack
typescript
Dominio
documentationfrontend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScriptGit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65