Redocly/redoc

Hiding regex expressions used for validation in Swagger and Redoc

Open

#668 aberto em 8 de out. de 2018

Ver no GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (2.272 forks)batch import
Type: Enhancementhelp wanted

Métricas do repositório

Stars
 (21.877 stars)
Métricas de merge de PR
 (Mesclagem média 3h 40m) (11 fundiu PRs em 30d)

Description

When we use a regex as a validator in swagger the regex shows up in our redoc documentation. We don't believe that our users will understand these random regular expressions in the documentation. Is there a way to hide the regular expression from the documentation. Or possibly define the validator as an object. I'm doubting that redoc would print an entire object to the documentation (if an object was used). A small example would be great... TY

Guia do colaborador

Direção de pesquisa
Investigue os componentes React que renderizam esquemas OpenAPI no Redoc, especificamente como os campos de padrão são exibidos. Verifique se existe uma opção de configuração existente para ocultar padrões de validação. Considere adicionar uma prop para permitir ocultar regex na documentação. Revise os comentários na issue para discussão anterior.
Pilha de tecnologia
typescriptreact
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-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Antigo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
ReactTypeScriptOpenAPIRegular expressions
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
50