fix(spp_api_v2_change_request): use Literal type for finite-valued str fields

Replace plain str with Literal for fields that have a known, fixed set of
valid values: ChangeRequestResponse.status and ChangeRequestTypeInfo.target_type.
This provides stricter validation and clearer API documentation.

Author: jeremi

spp_api_v2/services/schema_builder.py

@@ -189,11 +189,12 @@ def _extract_selection_choices(self, field) -> list[dict[str, str]]:
         Handles both list-of-tuples and callable selections.
         """
         selection = field.selection
+        field_name = field.name
         if callable(selection):
             try:
                 selection = selection(self.env[field.model_name])
             except Exception:
-                _logger.warning("Could not evaluate callable selection for %s", field.name, exc_info=True)
+                _logger.warning("Could not evaluate callable selection for %s", field_name, exc_info=True)
                 return []
         if not selection:
             return []
@@ -202,7 +203,7 @@ def _extract_selection_choices(self, field) -> list[dict[str, str]]:
             if isinstance(item, (list, tuple)) and len(item) >= 2:
                 result.append({"value": item[0], "label": item[1]})
             else:
-                _logger.debug("Skipping unparseable selection item for %s: %r", field.name, item)
+                _logger.debug("Skipping unparseable selection item for %s: %r", field_name, item)
         return result
 
     def _extract_vocabulary_info_from_domain(

spp_api_v2_change_request/__manifest__.py

@@ -25,32 +25,4 @@
     "summary": """
         REST API endpoints for Change Request V2.
     """,
-    "description": """
-OpenSPP API V2 - Change Request
-================================
-
-Extends OpenSPP API V2 with Change Request endpoints.
-
-Endpoints
----------
-- ``POST /ChangeRequest`` - Create a new change request
-- ``GET /ChangeRequest/{identifier}`` - Read a change request by reference
-- ``GET /ChangeRequest`` - Search change requests
-- ``PUT /ChangeRequest/{identifier}`` - Update change request detail data
-- ``POST /ChangeRequest/{identifier}/$submit`` - Submit for approval
-- ``POST /ChangeRequest/{identifier}/$approve`` - Approve (requires permission)
-- ``POST /ChangeRequest/{identifier}/$reject`` - Reject (requires permission)
-- ``POST /ChangeRequest/{identifier}/$request-revision`` - Request revision (requires permission)
-- ``POST /ChangeRequest/{identifier}/$apply`` - Apply changes to registrant
-- ``POST /ChangeRequest/{identifier}/$reset`` - Reset rejected/revision CR to draft
-- ``GET /ChangeRequest/$types`` - List all active CR types
-- ``GET /ChangeRequest/$types/{code}`` - Get field schema for a CR type
-
-Design Principles
------------------
-- Uses CR reference (CR/2024/00001), NOT database IDs
-- Returns appropriate HTTP status codes
-- Follows OpenSPP API V2 patterns
-- Requires authentication via OAuth 2.0
-    """,
 }

spp_api_v2_change_request/schemas/change_request.py

@@ -103,10 +103,9 @@ class ChangeRequestResponse(BaseModel):
     request_type: ChangeRequestType = Field(..., alias="requestType")
 
     # Status
-    status: str = Field(
+    status: Literal["draft", "pending", "revision", "approved", "rejected", "applied"] = Field(
         ...,
         description="Current status",
-        json_schema_extra={"enum": ["draft", "pending", "revision", "approved", "rejected", "applied"]},
     )
 
     # Target registrant
@@ -202,7 +201,9 @@ class ChangeRequestTypeInfo(BaseModel):
 
     code: str = Field(..., description="Type code (e.g., add_member)")
     name: str = Field(..., description="Human-readable type name")
-    target_type: str = Field(..., alias="targetType", description="Target registrant type (individual, group, both)")
+    target_type: Literal["individual", "group", "both"] = Field(
+        ..., alias="targetType", description="Target registrant type"
+    )
     requires_applicant: bool = Field(False, alias="requiresApplicant", description="Whether an applicant is required")
 
     class Config: