cont. updating mobile specs to use committee gem (#19148)

department-of-veterans-affairs · Nov 4, 2024 · 7269442 · 7269442
1 parent 05ea997
commit 7269442
Show file tree

Hide file tree

Showing 20 changed files with 393 additions and 180 deletions.
diff --git a/modules/mobile/docs/openapi.json b/modules/mobile/docs/openapi.json
diff --git a/modules/mobile/docs/schemas/Address.yml b/modules/mobile/docs/schemas/Address.yml
@@ -22,9 +22,11 @@ properties:
     type: string
     example: "1493 Martin Luther King Rd"
   addressLine2:
-    type: string, null
+    type: string
+    nullable: true
   addressLine3:
-    type: string, null
+    type: string
+    nullable: true
   addressPou:
     type: string
     enum: [ "RESIDENCE/CHOICE", "CORRESPONDENCE" ]
@@ -40,10 +42,12 @@ properties:
     type: string
     example: "US"
   internationalPostalCode:
-    type: string, null
+    type: string
+    nullable: true
     example: null
   province:
-    type: string, null
+    type: string
+    nullable: true
     example: null
   stateCode:
     type: string
@@ -52,5 +56,6 @@ properties:
     type: string
     example: "97062"
   zipCodeSuffix:
-    type: string, null
+    type: string
+    nullable: true
     example: "1234"
diff --git a/modules/mobile/docs/schemas/AddressCreate.yml b/modules/mobile/docs/schemas/AddressCreate.yml
@@ -33,9 +33,11 @@ properties:
         type: string
         example: "1493 Martin Luther King Rd"
       addressLine2:
-        type: string, null
+        type: string
+        nullable: true
       addressLine3:
-        type: string, null
+        type: string
+        nullable: true
       addressPou:
         type: string
         enum: [ "RESIDENCE/CHOICE", "CORRESPONDENCE" ]
@@ -51,17 +53,22 @@ properties:
         type: string
         example: "USA"
       internationalPostalCode:
-        type: string, null
+        type: string
+        nullable: true
         example: null
       province:
-        type: string, null
+        type: string
+        nullable: true
         example: null
       stateCode:
-        type: string, null
+        type: string
+        nullable: true
         example: "NY"
       zipCode:
-        type: string, null
+        type: string
+        nullable: true
         example: "97062"
       zipCodeSuffix:
-        type: string, null
+        type: string
+        nullable: true
         example: "1234"
diff --git a/modules/mobile/docs/schemas/AddressUpdate.yml b/modules/mobile/docs/schemas/AddressUpdate.yml
@@ -34,9 +34,11 @@ properties:
     type: string
     example: "1493 Martin Luther King Rd"
   addressLine2:
-    type: string, null
+    type: string
+    nullable: true
   addressLine3:
-    type: string, null
+    type: string
+    nullable: true
   addressPou:
     type: string
     enum: [ "RESIDENCE/CHOICE", "CORRESPONDENCE" ]
@@ -52,10 +54,12 @@ properties:
     type: string
     example: "US"
   internationalPostalCode:
-    type: string, null
+    type: string
+    nullable: true
     example: null
   province:
-    type: string, null
+    type: string
+    nullable: true
     example: null
   stateCode:
     type: string
@@ -64,5 +68,6 @@ properties:
     type: string
     example: "97062"
   zipCodeSuffix:
-    type: string, null
+    type: string
+    nullable: true
     example: "1234"
diff --git a/modules/mobile/docs/schemas/Appeal.yml b/modules/mobile/docs/schemas/Appeal.yml
@@ -37,7 +37,7 @@ properties:
           - type
           - updated
         properties:
-          appealsIds:
+          appealIds:
             type: array
             items:
               type: string
@@ -60,6 +60,7 @@ properties:
             type: string
           docket:
             type: object
+            nullable: true
           events:
             type: array
             items:

diff --git a/modules/mobile/docs/schemas/AppealIssue.yml b/modules/mobile/docs/schemas/AppealIssue.yml
@@ -5,10 +5,12 @@ properties:
   description:
     type: string
   diagnosticCode:
-    type: string, null
+    type: string
+    nullable: true
     example: 8100
   lastAction:
     type: string
+    nullable: true
     enum:
       - field_grant
       - withdrawn
@@ -22,3 +24,5 @@ properties:
       - Deferred
   date:
     type: string
+    nullable: true
+
diff --git a/modules/mobile/docs/schemas/AppointmentCheckin.yml b/modules/mobile/docs/schemas/AppointmentCheckin.yml
@@ -1,12 +1,38 @@
 type: object
 additionalProperties: false
 required:
-  - code
-  - message
+  - data
 properties:
-  code:
-    type: string
-    example: 'check-in-success'
-  message:
-    type: string
-    example: 'Check-In successful'
+  data:
+    type: object
+    additionalProperties: false
+    required:
+      - type
+      - id
+      - attributes
+    properties:
+      type:
+        type: string
+        example: "check_in"
+      id:
+        type: string
+        example: "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab"
+        description: user uuid
+      attributes:
+        type: object
+        additionalProperties: false
+        required:
+          - id
+          - code
+          - message
+        properties:
+          id:
+            type: string
+            example: "75db6a5c-84ae-4ca4-bba2-ef4c41d563ab"
+            description: user uuid
+          code:
+            type: string
+            example: 'check-in-success'
+          message:
+            type: string
+            example: 'Check-In successful'
diff --git a/modules/mobile/docs/schemas/AppointmentCheckinErrors400.yml b/modules/mobile/docs/schemas/AppointmentCheckinErrors400.yml
@@ -18,7 +18,7 @@ properties:
           type: string
           example: 'Unsuccessful Operation'
         detail:
-          type: array
+          type: [array, string]
           items:
             type: object
             additionalProperties: false

diff --git a/modules/mobile/docs/schemas/Claim.yml b/modules/mobile/docs/schemas/Claim.yml
@@ -46,10 +46,12 @@ properties:
             type: string
             example: "2017-12-08"
           minEstDate:
-            type: string, null
+            type: string
+            nullable: true
             example: "2017-12-08"
           maxEstDate:
-            type: string, null
+            type: string
+            nullable: true
             example: "2017-12-08"
           open:
             type: boolean
@@ -67,7 +69,8 @@ properties:
             items:
               $ref: "./claimEventTimeline.yml"
           phaseChangeDate:
-            type: string, null
+            type: string
+            nullable: true
             example: "2017-12-08"
           vaRepresentative:
             type: string

diff --git a/modules/mobile/docs/schemas/ClaimsAndAppeals.yml b/modules/mobile/docs/schemas/ClaimsAndAppeals.yml
@@ -48,15 +48,18 @@ properties:
         description: decision letter will be available from endpoint /v0/claims/decision-letters if true
         example: "true"
       phase:
-        type: integer, null
+        type: integer
+        nullable: true
         description: The phase of processing the claim is in. This does not apply to appeals. The integers used map to the phases as `1 => CLAIM_RECEIVED, 2 => UNDER_REVIEW, 3 => GATHERING_OF_EVIDENCE, 4 => REVIEW_OF_EVIDENCE, 5 => PREPARATION_FOR_DECISION, 6 => PENDING_DECISION_APPROVAL, 7 => PREPARATION_FOR_NOTIFICATION, 8 => COMPLETE`
         example: 1
       documentsNeeded:
-        type: boolean, null
+        type: boolean
+        nullable: true
         description: Documents are still needed.
         example: "true"
       developmentLetterSent:
-        type: boolean, null
+        type: boolean
+        nullable: true
         description: Development letter has been sent.
         example: "true"
       claimTypeCode:

diff --git a/modules/mobile/docs/schemas/DecisionLetterRecord.yml b/modules/mobile/docs/schemas/DecisionLetterRecord.yml
@@ -30,40 +30,50 @@ properties:
       - uploadDate
     properties:
       seriesId:
-        type: string, null
+        type: string
+        nullable: true
         example: "{EC1B5F0C-E3FB-4A41-B93F-E1A88D549CDF}"
       version:
-        type: string, null
+        type: string
+        nullable: true
         example: "1"
       typeDescription:
-        type: string, null
+        type: string
+        nullable: true
         example: "Notification Letter (e.g. VA 20-8993, VA 21-0290, PCGL)"
       typeId:
-        type: string, null
+        type: string
+        nullable: true
         example: "184"
       docType:
-        type: string, null
+        type: string
+        nullable: true
         example: "184"
       subject:
-        type: string, null
+        type: string
+        nullable: true
         example: null
       receivedAt:
         type: date
         example: "2022-09-22"
       source:
-        type: string, null
+        type: string
+        nullable: true
         example: "VBMS"
       mimeType:
-        type: string, null
+        type: string
+        nullable: true
         example: "application/pdf"
       altDocTypes:
-        type: string, null
+        type: string
+        nullable: true
         example: ""
       restricted:
         type: boolean
         example: false
       uploadDate:
-        type: date, null
+        type: date
+        nullable: true
         example: "2022-09-23"
 
 
diff --git a/modules/mobile/docs/schemas/PaymentHistory.yml b/modules/mobile/docs/schemas/PaymentHistory.yml
@@ -42,10 +42,12 @@ properties:
               type: string
               example: "Compensation & Pension - Recurring"
             bank:
-              type: string, null
+              type: string
+              nullable: true
               example: "PACIFIC PREMIER BANK"
             account:
-              type: string, null
+              type: string
+              nullable: true
               example: "************6464"
   meta:
     type: object