sphinx-contrib / sphinx-contrib/openapi
response content schema elements missing on OpenAPI 3.0
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
I've been using Sphinx OpenAPI previously with OpenAPI 2.0 specs. Now I'm dealing with my first OpenAPI 3.0 spec, and I've noticed that I can't find a "Response JSON Object" section on the different end-points. The schema is defined in the content element's content type (application/json) definition. The content is definitely in the spec (YAML file) and ReDoc as well as SwaggerUI show it.
Or am I doing anything wrong? I'm happy to provide further details.
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
Reproduce the report with the OpenAPI 3.0 YAML, focusing on response schemas nested under the content element for application/json. Compare the Sphinx-rendered endpoint output with the spec and the ReDoc or SwaggerUI output; done means the response JSON Object section and its schema elements appear for affected endpoints.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100