Redocly/redoc

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

Open

#991 aberto em 31 de jul. de 2019

Ver no GitHub
 (12 comments) (0 reactions) (1 assignee)TypeScript (2.272 forks)batch import
Type: Enhancementhelp wanted

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Localize o componente SchemaDefinition, encontre onde os nomes das propriedades são renderizados e adicione indicadores visuais para as propriedades readOnly e writeOnly.
Pilha de tecnologia
typescript
Domain
documentationfrontend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65