sphinx-contrib / sphinx-contrib/openapi
Ignore vendor extensions in new renderer
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
The new renderer does not assume that there may be vendor extensions in OAS objects. I'm not sure what's going to happen, I can assume the renderer will either fail or render garbage when vendor extensions are met. We need to ensure they are ignored.
For this, I think we should implement some helper function, e.g. oas_iteritems(vendor_extensions=False) that can iterate via OAS objects with or without vendor extensions based on the parameter, and use that helper inside the renderer.
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.py, the new renderer named in the issue. Inspect how it iterates over OAS objects and identify where vendor extensions are encountered. The work is done when vendor extensions are ignored during rendering without affecting ordinary OAS fields.
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
- 45/100