AMP-203 Added separate object for week commencing.

Author: vineetkapoor-hmcts

gradle/openapi.gradle

@@ -16,6 +16,6 @@ openApiGenerate {
     useTags                             : "true",   // use tag for api name
     generatedConstructorWithRequiredArgs: "false",  // else conflicts with lombok AllArgsConstructor
     openApiNullable                     : "false",  // else generates classes JsonNullable imports
-    additionalModelTypeAnnotations      : "@lombok.Builder;@lombok.AllArgsConstructor;@lombok.NoArgsConstructor",
+    additionalModelTypeAnnotations      : "@lombok.Builder;@lombok.AllArgsConstructor;@lombok.NoArgsConstructor;@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)",
   ]
 }

src/main/resources/openapi/openapi-spec.yml

@@ -13,13 +13,16 @@ info:
     name: MIT
     url: 'https://opensource.org/licenses/MIT'
 
+tags:
+  - name: Court Schedule
+    description: Court Schedule API
 paths:
   /case/{case_urn}/courtschedule:
     get:
+      tags:
+        - Court Schedule
       description: Retrieve details of a court schedule by case URN and court room.
       operationId: getCourtScheduleByCaseUrn
-      tags:
-        - court Schedule
       parameters:
         - in: path
           name: case_urn
@@ -35,6 +38,37 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/CourtScheduleResponse"
+              examples:
+                Allocated:
+                  summary: Allocated Hearing
+                  value:
+                    hearings:
+                      hearingId: "HRG-123410"
+                      hearingType: "Trial"
+                      hearingDescription: "Sentencing for theft case"
+                      listNote: "Requires interpreter"
+                      courtSittings: [ {
+                        sittingStart: "2025-03-18T09:00:00Z",
+                        sittingEnd: "2025-03-25T12:00:00Z",
+                        judiciaryId: "123e4567-e89b-12d3-a456-426614174000",
+                        courtHouse: "223e4567-e89b-12d3-a456-426614174111",
+                        courtRoom: "b7a9cb95-4f7c-4aba-b9a2-8cb1ad3330b2"
+                      }]
+                Week Commencing:
+                  summary: Week Commencing Hearing
+                  value:
+                    hearings:
+                      hearingId: "HRG-123906"
+                      hearingType: "Trial"
+                      hearingDescription: "Sentencing for theft case"
+                      listNote: "Requires interpreter"
+                      courtSittings: []
+                      weekCommencing:
+                        endDate: "2026-02-22"
+                        startDate: "2026-02-16"
+                        durationInWeeks: 1
+                        courtHouse: "223e4567-e89b-12d3-a456-426614174111"
+
         '400':
           description: Bad input parameter
           content:
@@ -72,24 +106,32 @@ components:
           description: Will always be required but can be null
           type: string
           example: "Judge prefers afternoon start"
-        weekCommencingStartDate:
-          description: "Proposed hearing week start date"
-          type: string
-          example: "2026-02-16"
-        weekCommencingEndDate:
-          description: "One week calculated end date"
-          type: string
-          example: "2026-02-22"
-        weekCommencingDurationInWeeks:
-          description: "Number of week(s) hearing is proposed for"
-          type: integer
-          example: 1
+        weekCommencing:
+          description: Details of Week Commencing Hearing
+          type: object
+          properties:
+            startDate:
+              description: "Proposed hearing week start Date"
+              type: string
+              example: "2026-02-16"
+            endDate:
+              description: "One week calculated end Date"
+              type: string
+              example: "2026-02-22"
+            durationInWeeks:
+              description: "Number of week(s) hearing is proposed for"
+              type: integer
+              example: 1
+            courtHouse:
+              description: Court house details ref id
+              type: string
+              pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$"
+              example: "223e4567-e89b-12d3-a456-426614174111"
         courtSittings:
           type: array
           items:
             $ref: '#/components/schemas/CourtSitting'
 
-
     CourtSitting:
       description: Details of court sittings
       type: object

src/main/resources/openapi/schema/courtSchedule.schema.json

@@ -43,6 +43,41 @@
                     "Judge prefers afternoon start"
                   ]
                 },
+                "weekCommencing": {
+                  "description": "Proposed hearing week start date",
+                  "type": "object",
+                  "properties": {
+                    "startDate": {
+                      "description": "Proposed hearing week start date",
+                      "type": "string",
+                      "examples": [
+                        "2026-02-16"
+                      ]
+                    },
+                    "endDate": {
+                      "description": "One week calculated end date",
+                      "type": "string",
+                      "examples": [
+                        "2026-02-22"
+                      ]
+                    },
+                    "durationInWeeks": {
+                      "description": "Number of week(s) hearing is proposed for",
+                      "type": "integer",
+                      "examples": [
+                        1
+                      ]
+                    },
+                    "courtHouse": {
+                      "description": "Court house details ref id",
+                      "type": "string",
+                      "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+                      "examples": [
+                        "223e4567-e89b-12d3-a456-426614174111"
+                      ]
+                    }
+                  }
+                },
                 "courtSittings": {
                   "description": "Details of court sittings",
                   "type": "array",

src/test/java/uk/gov/hmcts/cp/config/OpenApiObjectsTest.java

@@ -3,11 +3,8 @@
 import lombok.extern.slf4j.Slf4j;
 import org.junit.jupiter.api.Test;
 import uk.gov.hmcts.cp.openapi.api.CourtScheduleApi;
-import uk.gov.hmcts.cp.openapi.model.CourtSchedule;
-import uk.gov.hmcts.cp.openapi.model.CourtScheduleResponse;
-import uk.gov.hmcts.cp.openapi.model.CourtSitting;
-import uk.gov.hmcts.cp.openapi.model.ErrorResponse;
-import uk.gov.hmcts.cp.openapi.model.Hearing;
+import uk.gov.hmcts.cp.openapi.model.*;
+
 import java.lang.reflect.Field;
 import java.time.Instant;
 
@@ -37,7 +34,12 @@ void generated_court_sitting_should_have_expected_fields() {
 
     @Test
     void generated_hearing_should_have_expected_fields() {
-        assertThat(Hearing.class).hasDeclaredFields("hearingId", "hearingType", "hearingDescription", "listNote", "weekCommencingStartDate", "weekCommencingEndDate", "weekCommencingDurationInWeeks", "courtSittings");
+        assertThat(Hearing.class).hasDeclaredFields("hearingId", "hearingType", "hearingDescription", "listNote", "weekCommencing", "courtSittings");
+    }
+
+    @Test
+    void generated_week_commencing_should_have_expected_fields() {
+        assertThat(HearingWeekCommencing.class).hasDeclaredFields("startDate", "endDate", "durationInWeeks", "courtHouse");
     }
 
     @Test