Redocly/redoc

Hiding regex expressions used for validation in Swagger and Redoc

Open

#668 opened on Oct 8, 2018

View on GitHub
 (7 comments) (0 reactions) (0 assignees)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

Contributor guide

Tech stack
typescriptreact
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ReactTypeScriptOpenAPIRegular expressions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.