Merge pull request #13 from OpenSPP/fix/spp-api-v2-change-request-bugs

fix(spp_api_v2_change_request): fix 3 bugs and promote to Beta

Author: gonzalesedwin1123

spp_api_v2_change_request/README.rst

@@ -14,9 +14,9 @@ OpenSPP API V2 - Change Request
    !! source digest: sha256:ac0243c931848a9215f89c328fce09d312e30b92ac9c3c1f141bfe26b4fef453
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
-.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
     :target: https://odoo-community.org/page/development-status
-    :alt: Alpha
+    :alt: Beta
 .. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
     :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
     :alt: License: LGPL-3
@@ -128,11 +128,6 @@ Dependencies
 
 ``spp_api_v2``, ``spp_change_request_v2``
 
-.. IMPORTANT::
-   This is an alpha version, the data model and design can change at any time without warning.
-   Only for development or testing purpose, do not use in production.
-   `More details on development status <https://odoo-community.org/page/development-status>`_
-
 **Table of contents**
 
 .. contents::
@@ -168,10 +163,13 @@ Maintainers
 .. |maintainer-reichie020212| image:: https://github.com/reichie020212.png?size=40px
     :target: https://github.com/reichie020212
     :alt: reichie020212
+.. |maintainer-emjay0921| image:: https://github.com/emjay0921.png?size=40px
+    :target: https://github.com/emjay0921
+    :alt: emjay0921
 
 Current maintainers:
 
-|maintainer-jeremi| |maintainer-gonzalesedwin1123| |maintainer-reichie020212| 
+|maintainer-jeremi| |maintainer-gonzalesedwin1123| |maintainer-reichie020212| |maintainer-emjay0921| 
 
 This module is part of the `OpenSPP/OpenSPP2 <https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_api_v2_change_request>`_ project on GitHub.
 

spp_api_v2_change_request/__manifest__.py

@@ -6,8 +6,8 @@
     "author": "OpenSPP.org",
     "website": "https://github.com/OpenSPP/OpenSPP2",
     "license": "LGPL-3",
-    "development_status": "Alpha",
-    "maintainers": ["jeremi", "gonzalesedwin1123", "reichie020212"],
+    "development_status": "Beta",
+    "maintainers": ["jeremi", "gonzalesedwin1123", "reichie020212", "emjay0921"],
     "depends": [
         "spp_api_v2",
         "spp_change_request_v2",

spp_api_v2_change_request/routers/change_request.py

@@ -40,6 +40,11 @@
 change_request_router = APIRouter(tags=["ChangeRequest"], prefix="/ChangeRequest")
 
 
+def _build_reference(p1: str, p2: str, p3: str) -> str:
+    """Reconstruct CR reference from path segments (e.g., CR/2026/00001)."""
+    return f"{p1}/{p2}/{p3}"
+
+
 @change_request_router.post(
     "",
     response_model=ChangeRequestResponse,
@@ -87,9 +92,11 @@ async def create_change_request(
     return service.to_api_schema(cr)
 
 
-@change_request_router.get("/{reference}", response_model=ChangeRequestResponse)
+@change_request_router.get("/{p1}/{p2}/{p3}", response_model=ChangeRequestResponse)
 async def read_change_request(
-    reference: Annotated[str, Path(description="CR reference (e.g., CR/2024/00001)")],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
     response: Response,
@@ -106,6 +113,7 @@ async def read_change_request(
             detail="Client does not have permission to read change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -224,9 +232,11 @@ async def search_change_requests(
     )
 
 
-@change_request_router.put("/{reference}", response_model=ChangeRequestResponse)
+@change_request_router.put("/{p1}/{p2}/{p3}", response_model=ChangeRequestResponse)
 async def update_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     update_data: ChangeRequestUpdate,
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
@@ -245,6 +255,7 @@ async def update_change_request(
             detail="Client does not have permission to update change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -284,9 +295,11 @@ async def update_change_request(
 # === Actions ===
 
 
-@change_request_router.post("/{reference}/$submit", response_model=ChangeRequestResponse)
+@change_request_router.post("/{p1}/{p2}/{p3}/$submit", response_model=ChangeRequestResponse)
 async def submit_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
 ):
@@ -301,6 +314,7 @@ async def submit_change_request(
             detail="Client does not have permission to submit change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -321,9 +335,11 @@ async def submit_change_request(
     return service.to_api_schema(cr)
 
 
-@change_request_router.post("/{reference}/$approve", response_model=ChangeRequestResponse)
+@change_request_router.post("/{p1}/{p2}/{p3}/$approve", response_model=ChangeRequestResponse)
 async def approve_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
     action_data: ApproveActionData | None = None,
@@ -339,6 +355,7 @@ async def approve_change_request(
             detail="Client does not have permission to approve change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -360,9 +377,11 @@ async def approve_change_request(
     return service.to_api_schema(cr)
 
 
-@change_request_router.post("/{reference}/$reject", response_model=ChangeRequestResponse)
+@change_request_router.post("/{p1}/{p2}/{p3}/$reject", response_model=ChangeRequestResponse)
 async def reject_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     action_data: RejectActionData,
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
@@ -378,6 +397,7 @@ async def reject_change_request(
             detail="Client does not have permission to reject change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -398,9 +418,11 @@ async def reject_change_request(
     return service.to_api_schema(cr)
 
 
-@change_request_router.post("/{reference}/$request-revision", response_model=ChangeRequestResponse)
+@change_request_router.post("/{p1}/{p2}/{p3}/$request-revision", response_model=ChangeRequestResponse)
 async def request_revision_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     action_data: RequestRevisionActionData,
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
@@ -416,6 +438,7 @@ async def request_revision_change_request(
             detail="Client does not have permission to request revision",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -436,9 +459,11 @@ async def request_revision_change_request(
     return service.to_api_schema(cr)
 
 
-@change_request_router.post("/{reference}/$apply", response_model=ChangeRequestResponse)
+@change_request_router.post("/{p1}/{p2}/{p3}/$apply", response_model=ChangeRequestResponse)
 async def apply_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
 ):
@@ -453,6 +478,7 @@ async def apply_change_request(
             detail="Client does not have permission to apply change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 
@@ -473,9 +499,11 @@ async def apply_change_request(
     return service.to_api_schema(cr)
 
 
-@change_request_router.post("/{reference}/$reset", response_model=ChangeRequestResponse)
+@change_request_router.post("/{p1}/{p2}/{p3}/$reset", response_model=ChangeRequestResponse)
 async def reset_change_request(
-    reference: Annotated[str, Path()],
+    p1: Annotated[str, Path(description="Reference part 1 (e.g., CR)")],
+    p2: Annotated[str, Path(description="Reference part 2 (e.g., 2026)")],
+    p3: Annotated[str, Path(description="Reference part 3 (e.g., 00001)")],
     env: Annotated[Environment, Depends(odoo_env)],
     api_client: Annotated[dict, Depends(get_authenticated_client)],
 ):
@@ -490,6 +518,7 @@ async def reset_change_request(
             detail="Client does not have permission to reset change requests",
         )
 
+    reference = _build_reference(p1, p2, p3)
     service = ChangeRequestService(env)
     cr = service.find_by_reference(reference)
 

spp_api_v2_change_request/services/change_request_service.py

@@ -18,7 +18,8 @@ class ChangeRequestService:
     """Service for Change Request resource CRUD and mapping."""
 
     def __init__(self, env: Environment):
-        self.env = env
+        ctx = dict(env.context, mail_create_nolog=True, tracking_disable=True)
+        self.env = env(context=ctx)
 
     def find_by_reference(self, reference: str):
         """
@@ -161,7 +162,7 @@ def _serialize_detail(self, detail) -> dict[str, Any]:
         # Get fields from the model
         model_fields = detail._fields
 
-        # Skip internal and computed fields
+        # Skip internal, computed, and mail.thread fields
         skip_fields = {
             "id",
             "create_uid",
@@ -175,6 +176,20 @@ def _serialize_detail(self, detail) -> dict[str, Any]:
             "registrant_id",
             "approval_state",
             "is_applied",
+            # mail.thread fields
+            "message_ids",
+            "message_follower_ids",
+            "message_partner_ids",
+            "message_is_follower",
+            "has_message",
+            "message_needaction",
+            "message_needaction_counter",
+            "message_has_error",
+            "message_has_error_counter",
+            "message_attachment_count",
+            "message_has_sms_error",
+            "message_main_attachment_id",
+            "website_message_ids",
         }
 
         for field_name, field in model_fields.items():
@@ -451,5 +466,5 @@ def apply(self, cr):
     def reset_to_draft(self, cr):
         """Reset rejected/revision CR to draft."""
         if cr.approval_state not in ("rejected", "revision"):
-            raise UserError("Only rejected or revision-requested change requests " "can be reset to draft")
+            raise UserError("Only rejected or revision-requested change requests can be reset to draft")
         cr.action_reset_to_draft()

spp_api_v2_change_request/static/description/index.html

@@ -374,7 +374,7 @@ <h1>OpenSPP API V2 - Change Request</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:ac0243c931848a9215f89c328fce09d312e30b92ac9c3c1f141bfe26b4fef453
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_api_v2_change_request"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_api_v2_change_request"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
 <p>Exposes REST API endpoints for managing change requests through the
 OpenSPP API V2 framework. Allows external systems to create change
 requests, submit them for approval, and apply approved changes to
@@ -487,12 +487,6 @@ <h2>UI Location</h2>
 <div class="section" id="dependencies">
 <h2>Dependencies</h2>
 <p><tt class="docutils literal">spp_api_v2</tt>, <tt class="docutils literal">spp_change_request_v2</tt></p>
-<div class="admonition important">
-<p class="first admonition-title">Important</p>
-<p class="last">This is an alpha version, the data model and design can change at any time without warning.
-Only for development or testing purpose, do not use in production.
-<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
-</div>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -523,7 +517,7 @@ <h4><a class="toc-backref" href="#toc-entry-3">Authors</a></h4>
 <div class="section" id="maintainers">
 <h4><a class="toc-backref" href="#toc-entry-4">Maintainers</a></h4>
 <p>Current maintainers:</p>
-<p><a class="reference external image-reference" href="https://github.com/jeremi"><img alt="jeremi" src="https://github.com/jeremi.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/gonzalesedwin1123"><img alt="gonzalesedwin1123" src="https://github.com/gonzalesedwin1123.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/reichie020212"><img alt="reichie020212" src="https://github.com/reichie020212.png?size=40px" /></a></p>
+<p><a class="reference external image-reference" href="https://github.com/jeremi"><img alt="jeremi" src="https://github.com/jeremi.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/gonzalesedwin1123"><img alt="gonzalesedwin1123" src="https://github.com/gonzalesedwin1123.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/reichie020212"><img alt="reichie020212" src="https://github.com/reichie020212.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/emjay0921"><img alt="emjay0921" src="https://github.com/emjay0921.png?size=40px" /></a></p>
 <p>This module is part of the <a class="reference external" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_api_v2_change_request">OpenSPP/OpenSPP2</a> project on GitHub.</p>
 <p>You are welcome to contribute.</p>
 </div>