story(ccls-1814) linked cases

Includes CCLS-1815

caab-api/open-api-specification.yml

@@ -66,7 +66,7 @@ paths:
     get:
       tags:
         - applications
-      summary: 'get application type'
+      summary: 'Get application type'
       operationId: 'getApplicationType'
       parameters:
         - name: 'id'
@@ -94,7 +94,7 @@ paths:
     put:
       tags:
         - applications
-      summary: 'put application type'
+      summary: 'Update application type'
       operationId: 'putApplicationType'
       requestBody:
         description: put an application's application type
@@ -131,7 +131,7 @@ paths:
     get:
       tags:
         - applications
-      summary: 'get an applications provider details'
+      summary: 'Get an application''s provider details'
       operationId: 'getApplicationProviderDetails'
       parameters:
         - name: 'id'
@@ -159,7 +159,7 @@ paths:
     put:
       tags:
         - applications
-      summary: 'put an applications provider details'
+      summary: 'Update an application''s provider details'
       operationId: 'putApplicationProviderDetails'
       requestBody:
         description: put an application's application type
@@ -196,7 +196,7 @@ paths:
     get:
       tags:
         - applications
-      summary: 'get an applications correspondence address'
+      summary: 'Get an applications correspondence address'
       operationId: 'getApplicationCorrespondenceAddress'
       parameters:
         - name: 'id'
@@ -224,7 +224,7 @@ paths:
     put:
       tags:
         - applications
-      summary: 'put an applications correspondence address'
+      summary: 'Update an application''s correspondence address'
       operationId: 'putApplicationCorrespondenceAddress'
       requestBody:
         description: put an application's correspondence address
@@ -257,6 +257,149 @@ paths:
           description: 'Not found'
         '500':
           description: 'Internal server error'
+  /applications/{id}/linked-cases:
+    get:
+      tags:
+        - applications
+      summary: 'Get an application''s linked cases'
+      operationId: 'getApplicationLinkedCases'
+      parameters:
+        - name: 'id'
+          in: 'path'
+          required: true
+          schema:
+            type: 'integer'
+            format: 'int64'
+            example: '1234567890'
+      responses:
+        '200':
+          description: 'Successful operation'
+          content:
+            application/json:
+              schema:
+                type: 'array'
+                items:
+                  $ref: "#/components/schemas/linkedCase"
+        '400':
+          description: 'Bad request'
+        '401':
+          description: 'Unauthorized'
+        '404':
+          description: 'Not found'
+        '500':
+          description: 'Internal server error'
+    post:
+      tags:
+        - applications
+      summary: 'Add a linked case to an application'
+      operationId: 'addApplicationLinkedCase'
+      parameters:
+        - name: 'id'
+          in: 'path'
+          required: true
+          schema:
+            type: 'integer'
+            format: 'int64'
+        - name: 'Caab-User-Login-Id'
+          in: header
+          required: true
+          schema:
+            type: 'string'
+          example: '[email protected]'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/linkedCase"
+      responses:
+        '201':
+          description: 'Case added successfully'
+        '400':
+          description: 'Bad request'
+        '401':
+          description: 'Unauthorized'
+        '404':
+          description: 'Not found'
+        '500':
+          description: 'Internal server error'
+  /applications/{id}/linked-cases/{linked-case-id}:
+    delete:
+      tags:
+        - applications
+      summary: 'Remove a linked case from an application'
+      operationId: 'removeApplicationLinkedCase'
+      parameters:
+        - name: 'id'
+          in: 'path'
+          required: true
+          schema:
+            type: 'integer'
+            format: 'int64'
+        - name: 'linked-case-id'
+          in: 'path'
+          required: true
+          schema:
+            type: 'integer'
+            format: 'int64'
+        - name: 'Caab-User-Login-Id'
+          in: header
+          required: true
+          schema:
+            type: 'string'
+          example: '[email protected]'
+      responses:
+        '204':
+          description: 'No Content'
+        '400':
+          description: 'Bad request'
+        '401':
+          description: 'Unauthorized'
+        '404':
+          description: 'Not found'
+        '500':
+          description: 'Internal server error'
+    patch:
+      tags:
+        - applications
+      summary: 'Update a linked case of an application'
+      operationId: 'updateApplicationLinkedCase'
+      parameters:
+        - name: 'id'
+          in: 'path'
+          required: true
+          schema:
+            type: 'integer'
+            format: 'int64'
+        - name: 'linked-case-id'
+          in: 'path'
+          required: true
+          schema:
+            type: 'integer'
+            format: 'int64'
+        - name: 'Caab-User-Login-Id'
+          in: header
+          required: true
+          schema:
+            type: 'string'
+          example: '[email protected]'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/linkedCase"
+      responses:
+        '200':
+          description: 'Case updated successfully'
+        '400':
+          description: 'Bad request'
+        '401':
+          description: 'Unauthorized'
+        '404':
+          description: 'Not found'
+        '500':
+          description: 'Internal server error'
 components:
   schemas:
     intDisplayValue:
@@ -501,6 +644,8 @@ components:
     linkedCase:
       type: 'object'
       properties:
+        id:
+          type: 'integer'
         lsc_case_reference:
           type: 'string'
         relation_to_case: