sphinx-contrib / sphinx-contrib/openapi
Setting host for examples in openapi3
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
When rendering examples using an openapi3 yaml file, the host isn't selected from the list of servers but replace with example.com
Contributor guide
No contributing guide indexed for this repository
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 reproducing the rendering behavior with an OpenAPI 3 YAML file that defines multiple servers, then trace how the renderer chooses the host for examples. Done means rendered examples use the selected server host instead of example.com.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100