Redocly / Redocly/redoc

No padding between type and regex pattern

Open
#1,483 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

planned
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

I tried to use regex patterns for endpoints definitions... and something went wrong.
Regex patterns is showed normally, but... when body - between regex and type name is no padding at all (don't worry, when custom type is presented - everything is fine).
Btw, I'm on OpenAPI v2 Swagger and 0.10.2 redoc cli version.
So... if it's necessary I will provide some screenshots.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the reported OpenAPI v2 endpoint in Redoc CLI 0.10.2, using a regex pattern with a built-in type and then with a custom type. Compare the rendered spacing between the pattern and type name; done means the built-in-type rendering has the same padding as the custom-type case.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.