Redocly/redoc

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

Ouverte

#991 ouverte le 31 juil. 2019

Voir sur GitHubGuide contributeur
 (12 commentaires) (0 réaction) (1 personne assignée)TypeScript (2 272 forks)batch import
Type: Enhancementhelp wanted

Métriques du dépôt

Stars
 (21 877 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Localisez le composant SchemaDefinition, trouvez l'endroit où les noms de proprietes sont rendus et ajoutez des indicateurs visuels pour les proprietes readOnly et writeOnly.
Stack technique
typescript
Domaine
documentationfrontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScriptGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65