sphinx-contrib / sphinx-contrib/openapi
doc: request parameter is missing in the documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
The 'request' flag seems to be not in the documentation.
It is however in the code:
https://github.com/sphinx-contrib/openapi/blob/master/sphinxcontrib/openapi/renderers/_httpdomain_old.py#L23
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 with sphinxcontrib/openapi/renderers/_httpdomain_old.py at the linked code location and identify how the 'request' flag is represented. Find the corresponding documentation section, document the flag there, and verify that the documentation now covers this code-supported option.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100