Add error examples

department-of-veterans-affairs · Oct 8, 2024 · 40cd6b1 · 40cd6b1
1 parent 77e9566
commit 40cd6b1
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 12 deletions.
diff --git a/modules/representation_management/app/swagger/v0/swagger.json b/modules/representation_management/app/swagger/v0/swagger.json
@@ -33,27 +33,33 @@
               ],
               "properties": {
                 "title": {
-                  "type": "string"
+                  "type": "string",
+                  "example": "Unprocessable Entity"
                 },
                 "detail": {
-                  "type": "string"
+                  "type": "string",
+                  "example": "Your request could not be processed"
                 },
                 "code": {
-                  "type": "string"
+                  "type": "string",
+                  "example": "422"
                 },
                 "status": {
-                  "type": "string"
+                  "type": "string",
+                  "example": "422"
                 },
                 "meta": {
                   "type": "object",
                   "properties": {
                     "exception": {
-                      "type": "string"
+                      "type": "string",
+                      "example": "UnprocessableEntity"
                     },
                     "backtrace": {
                       "type": "array",
                       "items": {
-                        "type": "string"
+                        "type": "string",
+                        "example": "stack trace line"
                       }
                     }
                   }

diff --git a/modules/representation_management/spec/support/rswag_config.rb b/modules/representation_management/spec/support/rswag_config.rb
@@ -33,17 +33,23 @@ def config # rubocop:disable Metrics/MethodLength
                     type: :object,
                     required: [:title],
                     properties: {
-                      title: { type: :string },
-                      detail: { type: :string },
-                      code: { type: :string },
-                      status: { type: :string },
+                      title: { type: :string,
+                               example: 'Unprocessable Entity' },
+                      detail: { type: :string,
+                                example: 'Your request could not be processed' },
+                      code: { type: :string,
+                              example: '422' },
+                      status: { type: :string,
+                                example: '422' },
                       meta: {
                         type: :object,
                         properties: {
-                          exception: { type: :string },
+                          exception: { type: :string,
+                                       example: 'UnprocessableEntity' },
                           backtrace: {
                             type: :array,
-                            items: { type: :string }
+                            items: { type: :string,
+                                     example: 'stack trace line' }
                           }
                         }
                       }