Redocly/redoc

Hiding regex expressions used for validation in Swagger and Redoc

Open

#668 ouverte le 8 oct. 2018

Voir sur GitHub
 (7 commentaires) (0 réactions) (0 assignés)TypeScript (21 877 stars) (2 272 forks)batch import
Type: Enhancementhelp wanted

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

Guide contributeur

Stack technique
typescriptreact
Domaine
documentationfrontend
Type d'issue
feature
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-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
ReactTypeScriptOpenAPIRegular expressions
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50
Direction de recherche
Investigate the React components rendering OpenAPI schemas in Redoc, specifically how pattern fields are displayed. Check if there is an existing configuration option to hide validation patterns. Consider adding a prop to allow hiding regex in documentation. Review comments in issue for prior discussion.