Redocly/redoc

Hiding regex expressions used for validation in Swagger and Redoc

Open

#668 geöffnet am 8. Okt. 2018

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (2.272 Forks)batch import
Type: Enhancementhelp wanted

Repository-Metriken

Stars
 (21.877 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 3h 40m) (11 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Untersuche die React Komponenten, die OpenAPI Schemata in Redoc rendern, insbesondere wie Musterfelder angezeigt werden. Prüfe, ob es eine vorhandene Konfigurationsoption gibt, um Validierungsmuster auszublenden. Erwäge das Hinzufügen einer Prop, um das Ausblenden von Regex in der Dokumentation zu ermöglichen. Überprüfe die Kommentare im Issue für vorherige Diskussionen.
Tech Stack
typescriptreact
Domain
documentationfrontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ReactTypeScriptOpenAPIRegular expressions
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50