Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[pydantic] resolve nested schemas #453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anovis merged 2 commits into from
Nov 2, 2023
Merged

[pydantic] resolve nested schemas #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e61380
resolve schema of nested objects in pydantic responses
quajones Nov 1, 2023
7e617f0
revert
quajones Nov 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion goblet/handlers/plugins/pydantic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ def schema_helper(
if "$defs" in schema:
for k, v in schema["$defs"].items():
if k not in self.spec.components.schemas:
self.spec.components.schema(k, v)
self.spec.components.schema(k, self.resolve_schema(v))
del schema["$defs"]

return self.resolve_schema(schema)
Expand Down
20 changes: 20 additions & 0 deletions goblet/tests/test_openapispec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,14 @@ class PydanticModelReturnComplex(BaseModel):
objects: List[str]


class PydanticModelNestedOptionalProps(BaseModel):
data: List[PydanticModelReturnComplex]


def dummy_pydantic_return_nested_list() -> PydanticModelNestedOptionalProps:
pass


def dummy_pydantic_return() -> PydanticModelReturnComplex:
pass

Expand Down Expand Up @@ -637,3 +645,15 @@ def test_query_params_class_pydantic_return(self):
]
assert return_obj_props["option"]["type"] == "integer"
assert return_obj_props["objects"]["items"]["type"] == "string"

def test_nested_optional_field_pydantic_return(self):
route = RouteEntry(
dummy_pydantic_return_nested_list, "route", "/home/{id}", "GET"
)
spec = OpenApiSpec("test", "xyz.cloudfunction")
spec.add_route(route)
spec_dict = spec.component_spec.to_dict()
nested_return_props = spec_dict["definitions"]["PydanticModelReturnComplex"][
"properties"
]
assert nested_return_props["option"]["type"] == "integer"