fix appeals model

department-of-veterans-affairs · Sep 23, 2024 · 38ec245 · 38ec245
1 parent 94b8a97
commit 38ec245
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 6 deletions.
diff --git a/modules/mobile/app/models/mobile/v0/appeals/appeal.rb b/modules/mobile/app/models/mobile/v0/appeals/appeal.rb
@@ -5,6 +5,9 @@
 module Mobile
   module V0
     module Appeals
+      # This model is derived from the following docs: https://developer.va.gov/explore/api/appeals-status/docs?version=current
+      # We do not use the endpoint that these docs are for but instead share the same upstream service.
+      # The endpoint does not change the data in anyway so the docs should still be accurate.
       class Appeal < Common::Resource
         AOJ_TYPES = Types::String.enum(
           'vba',

diff --git a/modules/mobile/docs/index.html b/modules/mobile/docs/index.html
diff --git a/modules/mobile/docs/openapi.yaml b/modules/mobile/docs/openapi.yaml
@@ -61,7 +61,7 @@ paths:
   /v0/appeal/{id}:
     get:
       description: Returns info on all user's claims and appeals for mobile overview
-        page
+        page. Should be identical to the following docs https://developer.va.gov/explore/api/appeals-status/docs?version=current
       parameters:
         - description: Appeal Id
           in: path

diff --git a/modules/mobile/docs/schemas/Appeal.yml b/modules/mobile/docs/schemas/Appeal.yml
@@ -88,13 +88,38 @@ properties:
               - medical
               - burial
               - bva
+              - fiduciary
               - other
               - multiple
           status:
             type: object
             properties:
               details:
                 type: object
+                properties:
+                  lastSocDate:
+                    type: string
+                  certificationTimeliness:
+                    items:
+                      type: Integer
+                  ssocTimeliness:
+                    items:
+                      type: Integer
+                  decisionTimeliness:
+                    items:
+                      type: Integer
+                  remandTimeliness:
+                    items:
+                      type: Integer
+                  socTimeliness:
+                    items:
+                      type: Integer
+                  remandSsocTimeliness:
+                    items:
+                      type: Integer
+                  returnTimeliness:
+                    items:
+                      type: Integer
               type:
                 type: string
                 enum:
@@ -120,7 +145,24 @@ properties:
                   - remand_ssoc
                   - remand
                   - merged
+                  - evidentiary_period
+                  - ama_remand
+                  - post_bva_dta_decision
+                  - bva_decision_effectuation
+                  - sc_received
+                  - sc_decision
+                  - sc_closed
+                  - hlr_received
+                  - hlr_dta_error
+                  - hlr_decision
+                  - hlr_closed
+                  - statutory_opt_in
           type:
             type: string
+            enum:
+              - legacyAppeal
+              - appeal
+              - supplementalClaim
+              - higherLevelReview
           updated:
             type: string
diff --git a/modules/mobile/docs/schemas/AppealAlert.yml b/modules/mobile/docs/schemas/AppealAlert.yml
@@ -14,5 +14,7 @@ properties:
       - blocked_by_vso
       - scheduled_dro_hearing
       - dro_hearing_no_show
+      - evidentiary_period
+      - ama_post_decision
   details:
     type: object
diff --git a/modules/mobile/docs/schemas/AppealEvent.yml b/modules/mobile/docs/schemas/AppealEvent.yml
@@ -28,6 +28,16 @@ properties:
       - ramp_notice
       - transcript
       - remand_return
-      - dro_hearing_held
-      - dro_hearing_cancelled
-      - dro_hearing_no_show
+      - ama_nod
+      - docket_change
+      - distributed_to_vlj
+      - bva_decision_effectuation
+      - dta_decision
+      - sc_request
+      - sc_decision
+      - sc_other_close
+      - hlr_request
+      - hlr_decision
+      - hlr_dta_error
+      - hlr_other_close
+      - statutory_opt_in