litestar-org/pydantic-openapi-schema

Generate OpenAPI 3.x.x using Pydantic

pydantic-openapi-schema's Issues

Parameter doesn't depend on `param_in` attribute

There is a logic in description, that param_in attribute affects style attribute (see docstring under attr):
https://github.com/starlite-api/pydantic-openapi-schema/blob/7273555abe0d2255f8cfa657a785149c65f2812e/pydantic_openapi_schema/v3_1_0/parameter.py#L71

Also, there is a logic in description, that style attribute affects explode attribute:
https://github.com/starlite-api/pydantic-openapi-schema/blob/7273555abe0d2255f8cfa657a785149c65f2812e/pydantic_openapi_schema/v3_1_0/parameter.py#L81

But as I can see, it is just a description, and actually all these attributes don't affect each other. This is why Starlite has some issues with OpenAPI integration (e.g. litestar-org/litestar#1033).

Should we modify the building of OpenAPI parameters and how to resolve all listed dependencies (E.g. param_in=query => style=form => explode=True) in this repo. Or we should manage listed dependencies in Starlite?

Add an example of how to use

E.g. I want to add a pydantic nested model to an openapi dict.

Right now I do something like, for sure there's a better way. README and docs should have a proper example.

    schema["components"]["schemas"][
        "POSTMultipartParameters"
    ] = w2s.POSTMultipartParameters.schema()
    schema["components"]["schemas"]["POSTMultipartParameters"]["properties"]["file"].update(
        type="string", format="binary"
    )
    schema["components"]["schemas"]["W2"] = w2s.W2.schema()
    schema["components"]["schemas"]["W2S"] = w2s.W2S.schema()
    schema["components"]["schemas"]["NestedInW2"] = w2s.NestedInW2.schema()
    schema["components"]["schemas"]["AnotherNestedInW2"] = w2s.AnotherNestedInW2.schema()

    open_api = construct_open_api_with_schema_class(OpenAPI.parse_obj(schema))

Generate mkdocstrings docs

This will allow us to import the inventory into the starlite reference docs and cross reference to these docs.

See https://mkdocstrings.github.io/usage/#cross-references-to-other-projects-inventories

Allow to enable alias for OpenAPI310PydanticSchema

I use a pydantic model to serialize some data and return as a response. Some fields have alias.

The problem is that OpenAPI310PydanticSchema always returns property names taken from alias, while default is False. So there's a mismatch between the actual output and OpenAPI310PydanticSchema when by_alias is False (default)

Add CONTRIBUTING.md

We should add a CONTRIBUTING.md and link it in the readme properly.

Dependency: python 3.11 will require min pydantic 1.10 or a workaround

In Python 3.11 inspect.Parameter raises ValueError where a parameter name is a keyword (see python/cpython#92062).

We at least have Schema that triggers this error due to pydantic trying to create the aliases as parameters for the model signature, but there might be more too.

class Schema(BaseModel):
    schema_not: Optional[Union[Reference, "Schema"]] = Field(default=None, alias="not")
    schema_if: Optional[Union[Reference, "Schema"]] = Field(default=None, alias="if")

PR that resolves from the pydantic end is merged and available in the 1.10 pre-releases: pydantic/pydantic#4012.

I suppose we'll need a minimum 1.10 version constraint for pydantic based on the python version >=3.11

Update usage of tags

the tags key under Schema is currently typed as Optional[List[str]], but it should actually be Optional[List[Tag]]

Refactor: Remove 3.0.3

Starlite assumes a minimum of 3.1.0, so keeping 3.0.3 models isn't really worth the maintenance burden.