openapi
openapi copied to clipboard
sphinx-contrib
OpenAPI (fka Swagger) spec renderer for Sphinx.
Sphinx documentation generated from OpenAPI 3.0 doesn't contain information from `security` block. For example about required bearer token
The extension now supports multi-renderers architecture, which means we can have more than one renderer to render the OpenAPI spec. Each renderer may have its own set of configuration options,...
Generating a table of contents with direct links to the included paths/methods would be helpful when the generated documentation is long (e.g. when there are many paths/methods, when several or...
The exception looks like this: ``` Exception occurred: File "/usr/local/lib/python3.7/site-packages/sphinxcontrib/openapi/openapi20.py", line 75, in _httpresource for line in convert(header['description']).splitlines(): KeyError: 'description' ``` It appears to be because `_httpresource` blindly defererences `header['description']`....
I just played with your sphinx extension (thanks!) and saw that the generated documentation covers only part of the OpenAPI specification. This can already be seen with the BatComputer example...
I cannot import `sphinxcontrib.openapi` because of `docutils.core`. Can you please tell me which versions of `sphinx`, `sphinxcontrib.openapi`, and `docutils` I should use? **Here is the error:** ``` Running Sphinx v5.2.3...
get() possibly null header 'description' item instead of accessing it by key and rasing KeyError issue: https://github.com/sphinx-contrib/openapi/issues/130#issue-1402211100
Dear maintainers, I'll like to help with maintenance - in particular to upgrade the dependency avoiding the use of m2r. This is a follow-up of the issue I raised there:...
Metadata
Owner
Metadata
OpenAPI (fka Swagger) spec renderer for Sphinx.