Skip to content

Commit 3dc3051

Browse files
committed
add doc string
1 parent 6109224 commit 3dc3051

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

packages/models-library/src/models_library/utils/json_schema.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ def any_ref_key(obj):
9797

9898

9999
class GenerateResolvedJsonSchema(GenerateJsonSchema):
100+
"""Generates a json-schema with all $ref resolved
101+
Usage: pydantic_base_model.model_json_schema(schema_generator=GenerateResolvedJsonSchema) returns a json schema where it is guaranteed that all json references are resolved.
102+
"""
103+
100104
def generate(self, schema: CoreSchema, mode: JsonSchemaMode) -> JsonSchemaValue:
101105
schema_value = super().generate(schema=schema, mode=mode)
102106
schema_value = jsonref.replace_refs(schema_value, jsonschema=True)

0 commit comments

Comments
 (0)