`allOf` schema with multiple patterns is incorrectly shown in generated API Doc File
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- api, documentation
Research direction
Reproduce the issue with redocly preview-docs file.json using the supplied allOf schema and inspect how the generated API documentation renders both patterns and descriptions. Done means both allOf schemas appear completely and retain their own descriptions, similarly to the oneOf rendering.
Written by the indexing model from the issue text.
Description
Describe the bug
When you specify the following JSON Schema:
"allOf": [
{
"type": "string",
"description" : "first",
"pattern": "^(?=.*_session_id=)(?=.*auth_token=).*$"
},
{
"type": "string",
"description" : "second",
"pattern": ".*_tracking_id=.*"
}
]
The docs generated e.g. via redocly preview-docs file.json show this as mixed up and incomplete result (note how the description "first" is shown as the description of the second allOf case):
Instead, you would expect both schemas to show up in the generated docs, similarly to how the docs are generated for oneOf schemas.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Redocly/redoc
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
Type: Bug
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
vercel/react-tweet#225 ·