x-code-samples vs x-codeSamples for the Redoc CLI static pages
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
The Redoc CLI static pages do not properly show the code samples with the x-codeSamples definition. Instead, the x-code-samples must be used. Is this a documentation issue or a missing functionality issue?
This was with CLI version 0.8.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.
Research direction
Reproduce the static-page output with Redoc CLI version 0.8.4 using an OpenAPI definition containing x-codeSamples, then compare it with the result using x-code-samples. Trace the CLI static-page rendering entry point to identify where the definition is read; done means the documented x-codeSamples form displays code samples correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100