openapi icon indicating copy to clipboard operation
openapi copied to clipboard

OpenAPI (fka Swagger) spec renderer for Sphinx.

Results 56 openapi issues
Sort by recently updated
recently updated
newest added

In my sample project on AWS I've enabled cors and since then I get this error. `Exception occurred: File "/Users/cionzo/myproject/venv/lib/python3.8/site-packages/sphinxcontrib/openapi/openapi30.py", line 354, in _httpresource for line in convert(header['description']).splitlines(): KeyError: 'description'...

Running the tests using jsonschema version 4.19.2, I received the following warning: ``` ../../../../../usr/lib/python3/dist-packages/sphinxcontrib/openapi/utils.py:27 /usr/lib/python3/dist-packages/sphinxcontrib/openapi/utils.py:27: DeprecationWarning: jsonschema.RefResolver is deprecated as of v4.18.0, in favor of the https://github.com/python-jsonschema/referencing library, which provides...

I defined a custom FilterSet class for my DRF viewset. The field in question was defined as `from_date = DateTimeFilter(field_name="shift__start_time", lookup_expr="gte", label=_("from"))` with `from django.utils.translation import gettext_lazy as _`. Triggering...

I have the given [openapi.json](https://github.com/sphinx-contrib/openapi/files/14726482/openapi.json) which is generated using `fastapi` (I chopped it down to the relevant parts). The relevant snippet is this one: ```json { "components": { "schemas": {...

I'm trying to use [`sphinx-autobuild`](https://github.com/sphinx-doc/sphinx-autobuild) and `sphinxcontrib-openapi` together but I think that `sphinxcontrib-openapi` is doing some type of caching that is blocking `sphinx-autobuild` to work as expected when editing the...

help wanted

- pre-commit: Update hooks - Add support for Python 3.12, drop 3.7 - Bump action versions - docs: Trivial fixes - docs: Add docs for new renderer - Switch default...

If more than one path is specified under "exclude" option, the paths rendered will not be as expected. For example, if `/persons` and `/evidence` is specified, both will be rendered.

bug

Change to address the issue #146. Description of the problem is in the issue. Tested on my side. Let me know if you will merge it. I need to deploy...

Hello ! I am using the new release with the fix from the PR #143 and there is still an issue iwht anyOf attribute. Example: ```bash $ make doc python...

I've tried to use the `sphinxcontrib.openapi` on an openapi v2 received from kubernetes apiserver (`kubectl get --raw /openapi/v2 | yq -Poy`) apiserver but it failed with ``` Sphinx parallel build...