[suggestion] make appear downloadFileName in doc
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
We've been looking for a long time for how to explain the name of the downloadable OpenAPI specification file. The doc doesn't mention anything, and after searching through the minified files, we found the downloadFileName option.
Can you add it to the redocly.yaml examples or to the fillable fields of theme.openapi ?
Currently, entering this word in the search bar of https://redocly.com/docs does not give any results. its presence in the doc would have saved us a lot of time and effort.
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
Review the redocly.yaml examples and theme.openapi fillable fields mentioned in the issue, then locate the documentation source that controls their searchable text. Document the downloadFileName option and verify that searching the docs for downloadFileName returns the new entry.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100