sphinx-contrib / sphinx-contrib/openapi
Feature Request: Include / Exclude in new renderer
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
Setting openapi_default_renderer='httpdomain'does not allow using the documented filter operations anymore.
Checking the code, this seems to be the default case. As this would therefore always render the whole schema at once, it is rather unusable without a way to filter for methods and paths.
Is there a workaround for this?
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 examining the renderer behavior when openapi_default_renderer='httpdomain' is configured, then trace how the documented filter operations are handled. Done means the new renderer provides a usable way to include or exclude methods and paths instead of always rendering the whole schema.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100