eng: fix forward type reference in Pydantic schemas BNCH-112697 (#223)

eli-bl · web-flow · commit b758daa8f53c · 2024-12-02T10:29:50.000-08:00
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/header.py b/openapi_python_client/schema/openapi_schema_pydantic/header.py
@@ -29,3 +29,10 @@ class Header(Parameter):
             ]
         },
     )
+
+
+# Calling model_rebuild() here helps Pydantic to resolve the forward references that were used
+# in defining Parameter and Encoding. Without this call, any subtle change to the loading order
+# of schema submodules could result in an error like "Parameter is not fully defined".
+# See: https://docs.pydantic.dev/latest/concepts/models/#rebuilding-model-schema
+Parameter.model_rebuild()

Original file line number	Diff line number	Diff line change
`@@ -29,3 +29,10 @@ class Header(Parameter):`
`29`	`29`	`]`
`30`	`30`	`},`
`31`	`31`	`)`
	`32`	`+`
	`33`	`+`
	`34`	`+# Calling model_rebuild() here helps Pydantic to resolve the forward references that were used`
	`35`	`+# in defining Parameter and Encoding. Without this call, any subtle change to the loading order`
	`36`	`+# of schema submodules could result in an error like "Parameter is not fully defined".`
	`37`	`+# See: https://docs.pydantic.dev/latest/concepts/models/#rebuilding-model-schema`
	`38`	`+Parameter.model_rebuild()`