API-22657 526 v2 service description for attachments (#12973)

* Updates swagger docs for v2 dev * Updates routes file for updated route Changes to be committed: modified: modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json modified: modules/claims_api/config/routes.rb modified: modules/claims_api/spec/requests/v2/veterans/rswag_disability_compensation_request_spec.rb
department-of-veterans-affairs · Jun 13, 2023 · 935fbd2 · 935fbd2
1 parent 62acab2
commit 935fbd2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 6 deletions.
diff --git a/modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json b/modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json
@@ -4054,7 +4054,7 @@
         }
       }
     },
-    "/veterans/{veteranId}/526/attachments": {
+    "/veterans/{veteranId}/526/{id}/attachments": {
       "post": {
         "summary": "Upload documents supporting a 526 claim",
         "tags": [
@@ -4080,7 +4080,7 @@
             ]
           }
         ],
-        "description": "Used to attach supporting documents for a 526 claim. For wet-signature PDFs, use the PUT /forms/526/{id} endpoint.\n\n<br/><br/>\nThis endpoint accepts a document binary PDF as part of a multi-part payload (for example, attachment1, attachment2, attachment3).\n\n",
+        "description": "Uploads supporting documents related to a disability compensation claim. This endpoint accepts a document binary PDF as part of a multi-part payload.\n",
         "parameters": [
           {
             "name": "veteranId",

diff --git a/modules/claims_api/config/routes.rb b/modules/claims_api/config/routes.rb
@@ -55,7 +55,7 @@
       ## 526 Forms
       post '/:veteranId/526', to: 'disability_compensation#submit'
       post '/:veteranId/526/validate', to: 'disability_compensation#validate'
-      post '/:veteranId/526/attachments', to: 'disability_compensation#attachments'
+      post '/:veteranId/526/:id/attachments', to: 'disability_compensation#attachments'
       get '/:veteranId/526/getPDF', to: 'disability_compensation#get_pdf'
     end
   end

diff --git a/modules/claims_api/spec/requests/v2/veterans/rswag_disability_compensation_request_spec.rb b/modules/claims_api/spec/requests/v2/veterans/rswag_disability_compensation_request_spec.rb
@@ -147,7 +147,7 @@
     end
   end
 
-  path '/veterans/{veteranId}/526/attachments' do
+  path '/veterans/{veteranId}/526/{id}/attachments' do
     post 'Upload documents supporting a 526 claim' do
       tags 'Disability'
       operationId 'upload526Attachments'
@@ -159,8 +159,7 @@
       consumes 'multipart/form-data'
       produces 'application/json'
       put_description = <<~VERBIAGE
-        Used to attach supporting documents for a 526 claim. For wet-signature PDFs, use the PUT /forms/526/{id} endpoint.\n
-        <br/><br/>\nThis endpoint accepts a document binary PDF as part of a multi-part payload (for example, attachment1, attachment2, attachment3).\n
+        Uploads supporting documents related to a disability compensation claim. This endpoint accepts a document binary PDF as part of a multi-part payload.
       VERBIAGE
       description put_description