added models/interface.py

src/lsst/cmservice/models/interface.py

@@ -4,70 +4,121 @@
 
 
 class RematchQuery(BaseModel):
+    """Parameters needed to run error matching"""
+
+    # Rematch error that are already matched
     rematch: bool = False
 
 
 class FullnameQuery(BaseModel):
+    """Parameters needed to run query by fullname"""
+
+    # Fullname of Node
     fullname: str
 
 
 class NodeQuery(FullnameQuery):
+    """Parameters needed to run query for Node"""
+
     pass
 
 
 class UpdateNodeQuery(NodeQuery):
+    """Parameters needed to update a Node"""
+
+    # Value to update
     update_dict: dict
 
 
 class ProcessQuery(FullnameQuery):
+    """Parameters needed to process a Node"""
+
+    # If set, set the status without actually processing
     fake_status: int | None = None
 
 
 class ProcessNodeQuery(NodeQuery):
+    """Parameters needed to process a Node"""
+
+    # If set, set the status without actually processing
     fake_status: int | None = None
 
 
 class UpdateStatusQuery(NodeQuery):
+    """Parameters needed to update the status of a Node"""
+
+    # Status to set
     status: StatusEnum
 
 
 class ScriptQueryBase(FullnameQuery):
+    """Parameters needed to run query for Scripts associted to a Node"""
+
+    # Name of the script
     script_name: str
 
 
 class ScriptQuery(ScriptQueryBase):
+    """Parameters needed to run query for Scripts associated to a Node"""
+
+    # If True, return only unprocessed Scripts
     remaining_only: bool = False
+    # If True, skip all scripts marked as Superseded
     skip_superseded: bool = True
 
 
 class JobQuery(FullnameQuery):
+    """Parameters needed to identify a Job"""
+
+    # If True, return only unprocessed Jobs
     remaining_only: bool = False
+    # If True, skip all Jobs marked as Superseded
     skip_superseded: bool = True
 
 
 class AddGroups(FullnameQuery):
+    """Parameters needed to add groups to an existing step"""
+
+    # Configurations for new groups
     child_configs: dict
 
 
 class AddSteps(FullnameQuery):
+    """Parameters needed to add steps to an existing campaign"""
+
+    # Configurations for new steps
     child_configs: dict
 
 
 class YamlFileQuery(BaseModel):
+    """Parameters needed to load a yaml file"""
+
+    # Filename
     yaml_file: str
 
 
 class LoadAndCreateCampaign(YamlFileQuery):
+    # Name of the campaign
     name: str
+    # Name of the associated production
     parent_name: str
+    # Name of the associated Specification.  If empty, use production name
     spec_name: str | None = None
+    # Name of the associated SpecBlock.  If empty use specification#campaign
     spec_block_name: str | None = None
+    # Parameter Overrides
     data: dict | str | None = None
+    # Overrides for configuring child nodes
     child_config: dict | str | None = None
+    # Overrides for making collection names
     collections: dict | str | None = None
+    # Overrides for which SpecBlocks to use in constructing child Nodes
     spec_aliases: dict | str | None = None
+    # Override for Callback handler class
     handler: str | None = None
 
 
 class LoadManifestReport(YamlFileQuery, FullnameQuery):
+    """Parameters needed to load a report produced by pipetask report"""
+
     pass