Provide example string error, correct content type

department-of-veterans-affairs · Nov 26, 2024 · 5423612 · 5423612
1 parent 0dc7ec3
commit 5423612
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/modules/representation_management/app/swagger/v0/swagger.json b/modules/representation_management/app/swagger/v0/swagger.json
@@ -84,7 +84,8 @@
         }
       },
       "Error": {
-        "type": "string"
+        "type": "string",
+        "example": "Veteran first name can't be blank"
       },
       "PowerOfAttorneyResponse": {
         "type": "object",
@@ -210,7 +211,7 @@
           "422": {
             "description": "unprocessable entity response",
             "content": {
-              "application/pdf": {
+              "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/Errors"
                 }
@@ -443,7 +444,7 @@
           "422": {
             "description": "unprocessable entity response",
             "content": {
-              "application/pdf": {
+              "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/Errors"
                 }

diff --git a/..._management/spec/requests/representation_management/v0/pdf_generator_2122_swagger_spec.rb b/..._management/spec/requests/representation_management/v0/pdf_generator_2122_swagger_spec.rb
@@ -18,19 +18,20 @@
     post('Generate a PDF for form 21-22') do
       tags 'PDF Generation'
       consumes 'application/json'
-      produces 'application/pdf'
       operationId 'createPdfForm2122'
 
       parameter SwaggerSharedComponents::V0.body_examples[:pdf_generator2122_parameter]
 
       response '200', 'PDF generated successfully' do
+        produces 'application/pdf'
         let(:pdf_generator2122) do
           SwaggerSharedComponents::V0.body_examples[:pdf_generator2122]
         end
         run_test!
       end
 
       response '422', 'unprocessable entity response' do
+        produces 'application/json'
         let(:pdf_generator2122) do
           params = SwaggerSharedComponents::V0.body_examples[:pdf_generator2122]
           params[:veteran][:name].delete(:first)

diff --git a/...management/spec/requests/representation_management/v0/pdf_generator_2122a_swagger_spec.rb b/...management/spec/requests/representation_management/v0/pdf_generator_2122a_swagger_spec.rb
@@ -15,19 +15,20 @@
     post('Generate a PDF for form 21-22a') do
       tags 'PDF Generation'
       consumes 'application/json'
-      produces 'application/pdf'
       operationId 'createPdfForm2122a'
 
       parameter SwaggerSharedComponents::V0.body_examples[:pdf_generator2122a_parameter]
 
       response '200', 'PDF generated successfully' do
+        produces 'application/pdf'
         let(:pdf_generator2122a) do
           SwaggerSharedComponents::V0.body_examples[:pdf_generator2122a]
         end
         run_test!
       end
 
       response '422', 'unprocessable entity response' do
+        produces 'application/json'
         let(:pdf_generator2122a) do
           params = SwaggerSharedComponents::V0.body_examples[:pdf_generator2122a]
           params[:veteran][:name].delete(:first)

diff --git a/modules/representation_management/spec/support/rswag_config.rb b/modules/representation_management/spec/support/rswag_config.rb
@@ -98,7 +98,8 @@ def errors
 
   def error
     {
-      type: :string
+      type: :string,
+      example: "Veteran first name can't be blank"
     }
   end