sphinx-contrib / sphinx-contrib/openapi
Full description of payload schema etc.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
I just played with your sphinx extension (thanks!) and saw that the generated documentation covers only part of the OpenAPI specification. This can already be seen with the BatComputer example in the docs. The paths, parameters and responses are present in the docs, but the schema for the payload is missing, as are the bounds on the integer parameters etc., even though the definitions are all there.
Is this on purpose (the documentation will be high level) or is there just some more work needed to show everything (as with ReDoc)?
I wish to get the best of both worlds, that is the inline documentation, but with full detail.
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 BatComputer example in the documentation and inspect the generated output against the OpenAPI definitions. The work is complete when payload schemas and integer parameter bounds are rendered inline alongside the existing paths, parameters, and responses.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100