semantic cleanup

backend/src/api/routes/git_schemas.py

@@ -14,6 +14,7 @@ from uuid import UUID
 from src.models.git import GitProvider, GitStatus, SyncStatus
 
 # [DEF:GitServerConfigBase:Class]
+# @PURPOSE: Base schema for Git server configuration attributes.
 class GitServerConfigBase(BaseModel):
     name: str = Field(..., description="Display name for the Git server")
     provider: GitProvider = Field(..., description="Git provider (GITHUB, GITLAB, GITEA)")
@@ -23,12 +24,14 @@ class GitServerConfigBase(BaseModel):
 # [/DEF:GitServerConfigBase:Class]
 
 # [DEF:GitServerConfigCreate:Class]
+# @PURPOSE: Schema for creating a new Git server configuration.
 class GitServerConfigCreate(GitServerConfigBase):
     """Schema for creating a new Git server configuration."""
     pass
 # [/DEF:GitServerConfigCreate:Class]
 
 # [DEF:GitServerConfigSchema:Class]
+# @PURPOSE: Schema for representing a Git server configuration with metadata.
 class GitServerConfigSchema(GitServerConfigBase):
     """Schema for representing a Git server configuration with metadata."""
     id: str
@@ -40,6 +43,7 @@ class GitServerConfigSchema(GitServerConfigBase):
 # [/DEF:GitServerConfigSchema:Class]
 
 # [DEF:GitRepositorySchema:Class]
+# @PURPOSE: Schema for tracking a local Git repository linked to a dashboard.
 class GitRepositorySchema(BaseModel):
     """Schema for tracking a local Git repository linked to a dashboard."""
     id: str
@@ -55,6 +59,7 @@ class GitRepositorySchema(BaseModel):
 # [/DEF:GitRepositorySchema:Class]
 
 # [DEF:BranchSchema:Class]
+# @PURPOSE: Schema for representing a Git branch metadata.
 class BranchSchema(BaseModel):
     """Schema for representing a Git branch."""
     name: str
@@ -64,6 +69,7 @@ class BranchSchema(BaseModel):
 # [/DEF:BranchSchema:Class]
 
 # [DEF:CommitSchema:Class]
+# @PURPOSE: Schema for representing Git commit details.
 class CommitSchema(BaseModel):
     """Schema for representing a Git commit."""
     hash: str
@@ -75,6 +81,7 @@ class CommitSchema(BaseModel):
 # [/DEF:CommitSchema:Class]
 
 # [DEF:BranchCreate:Class]
+# @PURPOSE: Schema for branch creation requests.
 class BranchCreate(BaseModel):
     """Schema for branch creation requests."""
     name: str
@@ -82,12 +89,14 @@ class BranchCreate(BaseModel):
 # [/DEF:BranchCreate:Class]
 
 # [DEF:BranchCheckout:Class]
+# @PURPOSE: Schema for branch checkout requests.
 class BranchCheckout(BaseModel):
     """Schema for branch checkout requests."""
     name: str
 # [/DEF:BranchCheckout:Class]
 
 # [DEF:CommitCreate:Class]
+# @PURPOSE: Schema for staging and committing changes.
 class CommitCreate(BaseModel):
     """Schema for staging and committing changes."""
     message: str
@@ -95,6 +104,7 @@ class CommitCreate(BaseModel):
 # [/DEF:CommitCreate:Class]
 
 # [DEF:ConflictResolution:Class]
+# @PURPOSE: Schema for resolving merge conflicts.
 class ConflictResolution(BaseModel):
     """Schema for resolving merge conflicts."""
     file_path: str
@@ -103,6 +113,7 @@ class ConflictResolution(BaseModel):
 # [/DEF:ConflictResolution:Class]
 
 # [DEF:DeploymentEnvironmentSchema:Class]
+# @PURPOSE: Schema for representing a target deployment environment.
 class DeploymentEnvironmentSchema(BaseModel):
     """Schema for representing a target deployment environment."""
     id: str
@@ -115,12 +126,14 @@ class DeploymentEnvironmentSchema(BaseModel):
 # [/DEF:DeploymentEnvironmentSchema:Class]
 
 # [DEF:DeployRequest:Class]
+# @PURPOSE: Schema for dashboard deployment requests.
 class DeployRequest(BaseModel):
     """Schema for deployment requests."""
     environment_id: str
 # [/DEF:DeployRequest:Class]
 
 # [DEF:RepoInitRequest:Class]
+# @PURPOSE: Schema for repository initialization requests.
 class RepoInitRequest(BaseModel):
     """Schema for repository initialization requests."""
     config_id: str