Configure Download button to switch between JSON and YAML format
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Is your feature request related to a problem? Please describe.
This blog post (https://redocly.com/blog/hide-download-button/) on the Redocly website implies that the OpenAPI definition source file can be downloaded in either YAML or JSON format, however, it appears to default to JSON format with no obvious way to change it.
Describe the solution you'd like
A configuration setting to set this to either YAML or JSON format would be greatly appreciated!
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
Start by locating the Download button and the code that serializes the OpenAPI definition for download. Determine how configuration is exposed, then verify that selecting YAML or JSON produces the requested format and preserves the current default behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100