department-of-veterans-affairs · roberttravispierce · Jun 27, 2024
diff --git a/Gemfile b/Gemfile
@@ -10,14 +10,14 @@ gem "acts_as_tree"
 
 # amoeba gem for cloning appeals
 gem "amoeba"
-gem "aws-sdk"
 # BGS
+
 gem "bgs", git: "https://github.com/department-of-veterans-affairs/ruby-bgs.git", ref: "a2e055b5a52bd1e2bb8c2b3b8d5820b1a404cd3d"
 # Bootsnap speeds up app boot (and started to be a default gem in 5.2).
 gem "bootsnap", require: false
 gem "browser"
 gem "business_time", "~> 0.9.3"
-gem "caseflow", git: "https://github.com/department-of-veterans-affairs/caseflow-commons", ref: "716b58caf2116da5fca21c3b3aeea6c9712f3b9d"
+gem "caseflow", git: "https://github.com/department-of-veterans-affairs/caseflow-commons", ref: "871f7034c502f8d7101bde74e58606716b601c70"
 gem "connect_mpi", git: "https://github.com/department-of-veterans-affairs/connect-mpi.git", ref: "a3a58c64f85b980a8b5ea6347430dd73a99ea74c"
 gem "connect_vbms", git: "https://github.com/department-of-veterans-affairs/connect_vbms.git", ref: "9807d9c9f0f3e3494a60b6693dc4f455c1e3e922"
 gem "console_tree_renderer", git: "https://github.com/department-of-veterans-affairs/console-tree-renderer.git", tag: "v0.1.1"
@@ -66,8 +66,6 @@ gem "redis-namespace"
 gem "redis-rails", "~> 5.0.2"
 gem "request_store"
 gem "roo", "~> 2.7"
-gem "rswag-api"
-gem "rswag-ui"
 # Use SCSS for stylesheets
 gem "sass-rails", "~> 5.0"
 # Error reporting to Sentry
@@ -116,7 +114,6 @@ group :test, :development, :demo do
   gem "rspec-rails"
   # For CircleCI test metadata analysis
   gem "rspec_junit_formatter"
-  gem "rswag-specs"
   gem "rubocop", "= 0.83", require: false
   gem "rubocop-performance"
   gem "rubocop-rails"

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -9,11 +9,11 @@ GIT
 
 GIT
   remote: https://github.com/department-of-veterans-affairs/caseflow-commons
-  revision: 716b58caf2116da5fca21c3b3aeea6c9712f3b9d
-  ref: 716b58caf2116da5fca21c3b3aeea6c9712f3b9d
+  revision: 871f7034c502f8d7101bde74e58606716b601c70
+  ref: 871f7034c502f8d7101bde74e58606716b601c70
   specs:
     caseflow (0.4.8)
-      aws-sdk-s3
+      aws-sdk (~> 3.2)
       bourbon (= 4.2.7)
       d3-rails
       jquery-rails
@@ -1642,8 +1642,6 @@ GEM
       railties (>= 4.2.0)
       thor (>= 0.14, < 2.0)
     json (2.3.0)
-    json-schema (4.3.0)
-      addressable (>= 2.8)
     json_schemer (0.2.16)
       ecma-re-validator (~> 0.2)
       hana (~> 1.3)
@@ -1870,17 +1868,6 @@ GEM
     rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rswag-api (2.13.0)
-      activesupport (>= 3.1, < 7.2)
-      railties (>= 3.1, < 7.2)
-    rswag-specs (2.13.0)
-      activesupport (>= 3.1, < 7.2)
-      json-schema (>= 2.2, < 5.0)
-      railties (>= 3.1, < 7.2)
-      rspec-core (>= 2.14)
-    rswag-ui (2.13.0)
-      actionpack (>= 3.1, < 7.2)
-      railties (>= 3.1, < 7.2)
     rubocop (0.83.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
@@ -2035,7 +2022,6 @@ DEPENDENCIES
   acts_as_tree
   amoeba
   anbt-sql-formatter
-  aws-sdk
   bgs!
   bootsnap
   brakeman
@@ -2106,9 +2092,6 @@ DEPENDENCIES
   rspec-rails
   rspec-retry
   rspec_junit_formatter
-  rswag-api
-  rswag-specs
-  rswag-ui
   rubocop (= 0.83)
   rubocop-performance
   rubocop-rails
@@ -2139,4 +2122,4 @@ DEPENDENCIES
   ziptz
 
 BUNDLED WITH
-   2.4.17
+   2.4.19
diff --git a/Makefile.example b/Makefile.example
@@ -135,9 +135,6 @@ destroy: clean
 lint:  ## Run linter for javascript and ruby
 	bundle exec rake lint
 
-rubocop: ## Run linter for ruby
-	bundle exec rake rubocop -a
-
 jslint:  ## Run linter for javascript
 	cd client && yarn run lint
 

diff --git a/app/controllers/api/application_controller.rb b/app/controllers/api/application_controller.rb
@@ -92,14 +92,4 @@ def upstream_known_error(error)
       ]
     }, status: error.code || :bad_request
   end
-
-  def endpoint_disabled(message)
-    result = {
-      uuid: SecureRandom.uuid,
-      code: "VEFSERR50102",
-      message: "Operation not enabled. #{message}"
-    }
-
-    render json: result, status: :not_implemented
-  end
 end
diff --git a/app/controllers/swagger/idt/swagger.yaml → ...llers/api/docs/pacman/idt-pacman-spec.yml b/app/controllers/swagger/idt/swagger.yaml → ...llers/api/docs/pacman/idt-pacman-spec.yml
@@ -1,4 +1,3 @@
----
 openapi: 3.0.2
 info:
   title: IDT-Caseflow-Package Manager Bridge API
@@ -11,12 +10,13 @@ info:
     name: Apache 2.0
     url: https://www.apache.org/licenses/LICENSE-2.0
   version: 1.0.0
-security:
-  - bearerAuth: []
 servers:
-- url: /
+- url: https://appeals.cf.uat.ds.va.gov
+  description: UAT/Staging server
+- url: http://localhost:3000
+  description: Local Development server
 paths:
-  /addresses/validate:
+  /idt/api/v1/addresses/validate:
     post:
       tags:
         - Address Validation
@@ -93,8 +93,7 @@ paths:
         <ul>
           <li>country</li>
         </ul>
-      servers:
-        - url: /idt/api/v1/
+
       requestBody:
         content:
           application/json:
@@ -171,17 +170,14 @@ paths:
                     type: string
                 example:
                   message: 'Lighthouse API Error ID: 322483ae-7953-4d3c-9738-e108506d52c2 An unexpected error occurred, please try again.'
-  /appeals/{appeal_id}/upload_document:
+  /idt/api/v1/appeals/{appeal_id}/upload_document:
     post:
       tags:
         - Document Posting
       summary: Used for uploading documents to eFolder for specific appeals/veterans
-      servers:
-        - url: /idt/api/v1/
       parameters:
         - in: path
           name: appeal_id
-          example: cc165d4f-1e16-4bcf-9134-4f864c121c97
           schema:
             type: string
           required: true
@@ -399,13 +395,11 @@ paths:
                       message:
                         type: string
                         example: "Unexpected error: job error"
-  /upload_document:
+  /idt/api/v1/upload_document:
     post:
       tags:
         - Document Posting
       summary: Used for uploading documents to eFolder for specific appeals/veterans
-      servers:
-        - url: /idt/api/v1/
       requestBody:
         content:
           application/json:
@@ -623,17 +617,14 @@ paths:
                     errors:
                       "distribution 1": "Address line 3 can't be blank"
 
-  /appeals/{appeal_id}/outcode:
+  /idt/api/v2/appeals/{appeal_id}/outcode:
     post:
       tags:
         - Document Posting
       summary: Route used for outcoding decision reviews
-      servers:
-        - url: /idt/api/v2/
       parameters:
         - in: path
           name: appeal_id
-          example: cc165d4f-1e16-4bcf-9134-4f864c121c97
           schema:
             type: string
           required: true
@@ -885,17 +876,14 @@ paths:
                         detail:
                           type: string
                           example: "The veteran file number does not match the file number in VBMS"
-  /distributions/{distribution_id}:
+  /idt/api/v2/distributions/{distribution_id}:
     get:
       tags:
         - Distribution Tracking
       summary: Queries Package Manager for information on a specified distribution.
-      servers:
-        - url: /idt/api/v2/
       parameters:
         - in: path
           name: distribution_id
-          example: 1234
           schema:
             type: string
           required: true
@@ -1379,7 +1367,7 @@ components:
           type: number
           format: double
   securitySchemes:
-    bearerAuth:
-      type: http
-      scheme: bearer
-      description: API Key provided by Caseflow
+    ApiKeyAuth:
+      type: apiKey
+      in: header
+      name: TOKEN
diff --git a/app/controllers/swagger/v3/ama_issues.yaml → app/controllers/api/docs/v3/ama_issues.yaml b/app/controllers/swagger/v3/ama_issues.yaml → app/controllers/api/docs/v3/ama_issues.yaml
@@ -34,12 +34,10 @@ info:
     ```
 
   version: 3.0.0
-security:
-  - bearerAuth: []
 servers:
-- url: /api/v3/issues/ama/
+  - url: '{{CaseflowInstance}}/api/v3/ama_issues'
 paths:
-  /find_by_veteran/{veteran_participant_id}:
+  /api/v3/issues/ama/find_by_veteran/{veteran_participant_id}:
     get:
       tags:
         - Request Issues
@@ -48,7 +46,6 @@ paths:
           in: path
           required: true
           description: Veteran Participant ID
-          example: 123456789
           schema:
             $ref: "#/components/schemas/VeteranParticipantId"
         - in: query
@@ -534,8 +531,3 @@ components:
             updated_at:
               type: string
               description: "The date and time the record was updated"
-  securitySchemes:
-    bearerAuth:
-      type: http
-      scheme: bearer
-      description: API Key provided by Caseflow
diff --git a/...trollers/swagger/v3/decision_reviews.yaml → ...rollers/api/docs/v3/decision_reviews.yaml b/...trollers/swagger/v3/decision_reviews.yaml → ...rollers/api/docs/v3/decision_reviews.yaml
@@ -32,10 +32,8 @@ info:
     ```
 
   version: 3.0.0
-security:
-  - bearerAuth: []
 servers:
-- url: /api/v3/decision_reviews/
+  - url: '{{CaseflowInstance}}/api/v3/decision_reviews'
 paths:
   /higher_level_reviews:
     post:
@@ -47,7 +45,7 @@ paths:
 
         ### Asynchronous processing
 
-        The Decision Reviews API leverages a pattern recommended by JSON API for asynchronous processing (more information [here](https://jsonapi.org/recommendations/#asynchronous-processing)).  Submitting a Decision Review is an asynchronous process due to the multiple systems that are involved.  Because of this, when a new Decision Review is submitted, the POST endpoint will return a 202 `accepted` response including an Intake UUID.  That Intake UUID is associated with the submission and can be used as an identifier for the Intake Status endpoint.  While the submission is processing the Intake Status endpoint will return a 200 response.  Once the asynchronous process is complete and the Decision Review is submitted into Caseflow, the Intake Status endpoint will return a 303 response including the Decision Review ID for the submitted Decision Review, which will allow you to retrieve the full details including the processing status.
+        The Decision Reviews API leverages a pattern recommended by JSON API for asynchronous processing (more information [here](https://jsonapi.org/recommendations/#asynchronous-processing)).  Submitting a Decision Review is an asynchronous process due to the multiple systems that are involved.  Because of this, when a new Decision Review is submitted, the POST endpoint will return a 202 `accepted` response including an Intake UUID.  That Intake UUID is associated with the submission and can be used as an identifier for the Intake Status endpoint.  While the submission is processing the Intake Status endpoint will return a 200 response.  Once the asynchronous process is complete and the Decision Review is submitted into Caseflow, the Intake Status endpoint will return a 303 response including the Decision Review ID for the submitted Decision Review, which will allow you to retrieve the full details including the processing status. 
       requestBody:
         required: true
         content:
@@ -474,15 +472,14 @@ paths:
           in: path
           required: true
           description: Decision Review UUID
-          example: cc165d4f-1e16-4bcf-9134-4f864c121c97
           schema:
             $ref: "#/components/schemas/Uuid"
       summary: Check a Decision Review's (Higher-Level Review, Supplemental Claim, Board Appeal) intake status.
       description: >+
         After creating a Decision Review, you can use this endpoint to check its _intake status_—whether or not a Decision Review has been processed in the Caseflow system.
 
 
-        **A Decision Review is not immediately accessible after creation.** Intake involves communicating with several systems/databases asynchronously. Consequently, a new Decision Review isn't available for API interaction immediately after creation.
+        **A Decision Review is not immediately accessible after creation.** Intake involves communicating with several systems/databases asynchronously. Consequently, a new Decision Review isn't available for API interaction immediately after creation. 
 
 
         _Check a Decision Review's intake status to know when it has become accessible, and also its location for further actions._
@@ -491,7 +488,7 @@ paths:
         * **Before a Decision Review is successfully processed:** This endpoint will return `200 OK` and a JSON payload describing the status in more detail.
 
 
-        * **Once processing is complete:** this endpoint will return a `303 see other` and a Location header containing the URL of the processed, and now accessible, Decision Review. You can use that URL to get the Decision Review and retrieve its full details.
+        * **Once processing is complete:** this endpoint will return a `303 see other` and a Location header containing the URL of the processed, and now accessible, Decision Review. You can use that URL to get the Decision Review and retrieve its full details. 
       responses:
         '200':
           description: Processing incomplete
@@ -583,6 +580,7 @@ paths:
                       status: 500,
                       code: unknown_error
                       title: "Unknown error"
+
   /higher_level_reviews/{uuid}:
     get:
       tags:
@@ -592,7 +590,6 @@ paths:
           in: path
           required: true
           description: UUID of a Higher-Level Review
-          example: cc165d4f-1e16-4bcf-9134-4f864c121c97
           schema:
             type : string
             format: uuid
@@ -929,14 +926,9 @@ paths:
           in: header
           required: true
           description: (yyyy-mm-dd) In order to determine contestability of issues, the receipt date of a hypothetical Decision Review must be supplied.
-          example: '2000-01-01'
           schema:
             type: string
             format: date
-      servers:
-        - url: /api/v3/decision_reviews/higher_level_reviews/
-        - url: /api/v3/decision_reviews/supplemental_claims/
-        - url: /api/v3/decision_reviews/appeals/
       summary: Returns all contestable issues for a specific veteran.
       description: >-
         Returns all issues a Veteran could contest in a Decision Review
@@ -1422,8 +1414,3 @@ components:
                     * `attempted` - Processing of the DecisionReview is being attempted.
                     * `canceled` - The DecisionReview has been successfully canceled.
                     * `processed` - The DecisionReview has been processed and transmitted to the appropriate government agency.
-  securitySchemes:
-    bearerAuth:
-      type: http
-      scheme: bearer
-      description: API Key provided by Caseflow
diff --git a/...controllers/swagger/v3/vacols_issues.yaml → ...ontrollers/api/docs/v3/vacols_issues.yaml b/...controllers/swagger/v3/vacols_issues.yaml → ...ontrollers/api/docs/v3/vacols_issues.yaml
@@ -33,12 +33,10 @@ info:
     ```
 
   version: 3.0.0
-security:
-  - bearerAuth: []
 servers:
-- url: /api/v3/issues/vacols/
+  - url: '{{CaseflowInstance}}/api/v3/issues/vacols'
 paths:
-  /find_by_veteran:
+  /api/v3/issues/vacols/find_by_veteran:
     get:
       tags:
         - VACOLS Issues
@@ -274,8 +272,3 @@ components:
             issue_note:
               type: string
               description: "Notes added to the VACOLS Issue. This may be used to capture handwritten notes on the form, New Material or other comments."
-  securitySchemes:
-    bearerAuth:
-      type: http
-      scheme: bearer
-      description: API Key provided by Caseflow