<#786 fix: replace verbose docstrings with short d...
# flyte-github
a
#786 fix: replace verbose docstrings with short descriptions in File, Dir, and DataFrame JSON schemas Pull request opened by AdilFayyaz Motivation Pydantic's
model_json_schema()
includes the full class docstring as the description field, which leaked multi-line implementation docs into
LiteralType.metadata
affecting both Pydantic model and dataclass workflows (via PydanticSchemaPlugin). Summary • Set
json_schema_extra
on File, Dir, and DataFrame to override the docstring-derived description with a concise one-liner • Added
x-flyte-type
extension key ("file", "dir", "dataframe") to each schema for type identification Test Plan • Run
pytest tests/flyte/type_engine/pydantic/test_file_literal_type_metadata.py -v
• All 6 tests should pass, covering both the Pydantic and dataclass schema generation paths flyteorg/flyte-sdk