sphinx-contrib / sphinx-contrib/openapi
[feature request]: Filter by method for a path
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 126
- Forks
- 88
- PR merge metrics
- No merged PRs in 30d
Description
I am using the directive to include some generated API doc into my documentation, and thus using the :paths: parameter.
Would it be possible to select a list of method for each path, to avoid displaying all methods for a path ?
Like:
.. openapi:: my_spec.yml
:paths:
/resource[get,delete]
:encoding: utf-8
Thanks !
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
The entry point is the OpenAPI Sphinx directive that handles :paths:; start by tracing how its path list is parsed and filtered. Done means a path can specify methods such as /resource[get,delete], only those operations appear, and relevant existing tests cover the behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100