API-25108 deprecate veteran confirmation (#12412)

* set deprecation and sunset headers for VC and updated openapi yml to indicate VC is deprecated * removed extra emtpy line at end of method
department-of-veterans-affairs · Apr 17, 2023 · 9124523 · 9124523
1 parent 0b0731c
commit 9124523
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/modules/veteran_confirmation/VETERAN_CONFIRMATION.yml b/modules/veteran_confirmation/VETERAN_CONFIRMATION.yml
@@ -3,7 +3,7 @@ info:
   version: 0.0.1
   title: Veteran Confirmation
   description: |
-    The Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.
+    The Deprecated Veteran Confirmation API allows you to confirm Veteran status for a given person. This can be useful for offering Veterans discounts or other benefits.
 
     The API will only return “Confirmed” or “Not Confirmed”.
 
@@ -74,6 +74,7 @@ servers:
 paths:
   /status:
     post:
+      deprecated: true
       tags:
         - veteran_confirmation_status
       summary: Get confirmation about an individual's Veteran status according to the VA
@@ -133,25 +134,31 @@ components:
           type: string
           description: Social Security Number for the person of interest with or without dashes
           example: "555-55-5555"
+          deprecated: true
         first_name:
           type: string
           description: First name for the person of interest
           example: "John"
+          deprecated: true
         last_name:
           type: string
           description: Last name for the person of interest
           example: "Doe"
+          deprecated: true
         birth_date:
           type: string
           description: Birth date for the person of interest in any valid ISO8601 format
           example: "1965-01-01"
+          deprecated: true
         middle_name:
           type: string
           description: Optional middle name for the person of interest
           example: "Theodore"
+          deprecated: true
         gender:
           type: string
           description: Optional gender of M or F for the person of interest
+          deprecated: true
           enum:
             - M
             - F
@@ -167,6 +174,7 @@ components:
           enum:
             - confirmed
             - not confirmed
+          deprecated: true
     APIError:
       description: API invocation or processing error
       type: object

diff --git a/...veteran_confirmation/app/controllers/veteran_confirmation/v0/veteran_status_controller.rb b/...veteran_confirmation/app/controllers/veteran_confirmation/v0/veteran_status_controller.rb
@@ -18,6 +18,9 @@ def index
           gender: params['gender']
         )
 
+        response.set_header('Deprecation', 'true')
+        response.set_header('Sunset', 'Thu, 04 Apr 2024 23:59:59 UTC')
+
         render json: { veteran_status: status }
       end