add docstring for _construct_ref_object

mike-oakley · Dec 3, 2024 · 143d088 · 143d088
1 parent 49bbb4d
commit 143d088
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/openapi_pydantic/util.py b/openapi_pydantic/util.py
@@ -171,6 +171,15 @@ def _traverse(obj: Any) -> None:
 
 
 def _construct_ref_obj(pydantic_schema: PydanticSchema[PydanticType]) -> Reference:
+    """
+    Construct a reference object from the Pydantic schema name
+
+    characters in the schema name that are invalid/problematic
+    for JSONschema $ref names will get replaced with underscores.
+    Especially needed for Pydantic generic Models with brackets "[]"
+
+    see: https://github.com/pydantic/pydantic/blob/aee6057378ccfec02126bf9c984a9b6d6b411777/pydantic/json_schema.py#L2031
+    """
     ref_name = re.sub(
         r"[^a-zA-Z0-9.\-_]", "_", pydantic_schema.schema_class.__name__
     ).replace(".", "__")

diff --git a/openapi_pydantic/v3/v3_0/util.py b/openapi_pydantic/v3/v3_0/util.py
@@ -243,6 +243,15 @@ def _traverse(obj: Any) -> None:
 
 
 def _construct_ref_obj(pydantic_schema: PydanticSchema[PydanticType]) -> Reference:
+    """
+    Construct a reference object from the Pydantic schema name
+
+    characters in the schema name that are invalid/problematic
+    for JSONschema $ref names will get replaced with underscores.
+    Especially needed for Pydantic generic Models with brackets "[]"
+
+    see: https://github.com/pydantic/pydantic/blob/aee6057378ccfec02126bf9c984a9b6d6b411777/pydantic/json_schema.py#L2031
+    """
     ref_name = re.sub(
         r"[^a-zA-Z0-9.\-_]", "_", pydantic_schema.schema_class.__name__
     ).replace(".", "__")