Skip to content

Add helper text descriptions to Pydantic model fields for IDE integration #1753

@coderabbitai

Description

@coderabbitai

Context

During the review of PR #1741, it was noted that configuration field documentation is currently provided as YAML comments in template files. These could be enhanced by adding descriptions to Pydantic Field definitions, which would surface as helper texts in IDEs through the JSON schema reference.

Proposal

Add Field(..., description="...") annotations to Pydantic model fields in the configuration classes (e.g., LogIngestor, ClpConfig, and other configuration models in components/clp-py-utils/clp_py_utils/clp_config.py). This would enable IDE tooltips and better developer experience when editing configuration files.

References

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions