Skip to content

Commit 4381b4f

Browse files
authored
[core][fix] Export property documentation for configs (#2245)
1 parent 8626219 commit 4381b4f

4 files changed

Lines changed: 4 additions & 4 deletions

File tree

fixcore/fixcore/core_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -673,7 +673,7 @@ class EditableConfig(ConfigObject):
673673

674674
def config_model() -> List[Json]:
675675
config_classes = {EditableConfig, CustomCommandsConfig}
676-
return dataclasses_to_fixcore_model(config_classes)
676+
return dataclasses_to_fixcore_model(config_classes, with_prop_description=True)
677677

678678

679679
# Define rules to validate this config

fixcore/fixcore/report/report_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,4 +157,4 @@ def check_allowed(self, check_id: str) -> bool:
157157

158158
def config_model() -> List[Json]:
159159
config_classes = {ReportCheckCollectionConfig, BenchmarkConfig, ReportConfig}
160-
return dataclasses_to_fixcore_model(config_classes, use_optional_as_required=True)
160+
return dataclasses_to_fixcore_model(config_classes, use_optional_as_required=True, with_prop_description=True)

fixcore/fixcore/user/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,4 +113,4 @@ async def users(self) -> Dict[Email, FixInventoryUser]:
113113

114114
def config_model() -> List[Json]:
115115
config_classes: Set[Type[Any]] = {FixInventoryUsersConfig}
116-
return dataclasses_to_fixcore_model(config_classes, use_optional_as_required=True)
116+
return dataclasses_to_fixcore_model(config_classes, use_optional_as_required=True, with_prop_description=True)

fixlib/fixlib/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ def __eq__(self, other: Any) -> bool:
377377
def model(self) -> List[Json]:
378378
"""Return the config dataclass model in fixcore format"""
379379
classes = set(_config.classes.values())
380-
return dataclasses_to_fixcore_model(classes, use_optional_as_required=True)
380+
return dataclasses_to_fixcore_model(classes, use_optional_as_required=True, with_prop_description=True)
381381

382382
@staticmethod
383383
def add_args(arg_parser: ArgumentParser) -> None:

0 commit comments

Comments
 (0)