sphinx-contrib / sphinx-contrib/openapi
Support OpenAPI v3 parameters content
Open
Nobody has claimed this yet.
bug
old-renderer
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
document generation crashes with:
Exception occurred:
File ".../venv_sphinx/lib/python3.6/site-packages/sphinxcontrib/openapi/openapi30.py", line 281, in _httpresource
type=param['schema']['type'],
KeyError: 'schema'
since it does not seem to support parameters with content
https://swagger.io/docs/specification/describing-parameters/
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 in sphinxcontrib/openapi/openapi30.py at _httpresource, where the traceback shows the failing schema lookup. Read the linked OpenAPI parameter documentation to understand content-based parameters; done means document generation no longer crashes when such a parameter is used and produces the expected output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100