Redocly/redoc

Hiding regex expressions used for validation in Swagger and Redoc

Open

#668 aperta il 8 ott 2018

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)TypeScript (2272 fork)batch import
Type: Enhancementhelp wanted

Metriche repository

Star
 (21.877 star)
Metriche merge PR
 (Merge medio 3h 40m) (11 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Indaga sui componenti React che renderizzano gli schemi OpenAPI in Redoc, in particolare su come vengono visualizzati i campi pattern. Verifica se esiste un'opzione di configurazione esistente per nascondere i pattern di validazione. Considera l'aggiunta di una prop per consentire di nascondere le regex nella documentazione. Rivedi i commenti nell'issue per la discussione precedente.
Tech stack
typescriptreact
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-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ReactTypeScriptOpenAPIRegular expressions
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50