openapi

openapi copied to clipboard

Hi there, because our team would like to validate the correctness of Sphinx-syntax in our docstrings, we intend to use the `-W` parameter of `sphinx-build`. Unfortunately, this also converts this...

crazyscientist

PROBLEM: In the newest spec and pydantic capability you can give multiple types for validation. When I do a make html this breaks as there is not type key under...

havok4u

Type error thrown when schema uses oneOf

1

``` schema: oneOf: - type: array - type: string ``` Will throw `Exception occurred: File "/Users/maxmurmann/opt/anaconda3/envs/bullhorn-apis/lib/python3.8/site-packages/sphinxcontrib/openapi/openapi30.py", line 282, in _httpresource type=param['schema']['type'], KeyError: 'type' ` whereas I believe this should be...

maxmurmann

[feature request]: Filter by method for a path

1

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...

Kimamisa

Hello in the documentation you guys show how to provide a physical openapi file, but I would like to pass a url to it : https://petstore.swagger.io/v2/swagger.json

juniorschen

docs: Document how to switch to new renderer

1

Any reason why the new renderer is not default? Can I help?

igo95862

response content schema elements missing on OpenAPI 3.0

6

I've been using Sphinx OpenAPI previously with OpenAPI 2.0 specs. Now I'm dealing with my first OpenAPI 3.0 spec, and I've noticed that I can't find a "Response JSON Object"...

pohutukawa

Windows 10, Python 3.9, Sphinx==3.5.3 ``` Exception occurred: File "C:\Users\aye\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.9_qbz5n2kfra8p0\LocalCache\local-packages\Python39\site-packages\jsonschema\validators.py", line 782, in resolve_from_url raise exceptions.RefResolutionError(exc) jsonschema.exceptions.RefResolutionError: ``` I am using the same test case as #3 does and getting...

annanyearian

JSON Schema does not require `"type"` to be present for enums, see also https://json-schema.org/understanding-json-schema/reference/generic.html#enumerated-values. The plugin however requires it for all query parameter schemas: https://github.com/sphinx-contrib/openapi/blob/4f78db9c8ca2cefc4e4c1eeb46552a8d9d432855/sphinxcontrib/openapi/openapi30.py#L279-L282 Sample error: ``` 2021-01-12T14:38:38.9415027Z Exception...

letmaik

Schemas are assumed to be objects, not type combinators

4

https://github.com/sphinx-contrib/openapi/blob/547f6453753b9d7accb30fa8d1eee2b8e02ebc0d/sphinxcontrib/openapi/openapi30.py#L260 This line assumes that every `schema` it operates on will be `{type: string}`, `{type: object}` or soforth, and fails to support the type combinators `anyOf`, `oneOf` and `allOf` when...

arrdem