Merge pull request #11916 from transcom/B-18492-INT

B 18492 Prime API sitAddressUpdate Deprecation Documentation Updates
transcom · Feb 5, 2024 · e4c5c89 · e4c5c89
2 parents 37dfff8 + cd20cee
commit e4c5c89
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 4 deletions.
diff --git a/pkg/gen/primeapi/embedded_spec.go b/pkg/gen/primeapi/embedded_spec.go
diff --git a/pkg/gen/primeapi/primeoperations/sit_address_update/create_s_i_t_address_update_request.go b/pkg/gen/primeapi/primeoperations/sit_address_update/create_s_i_t_address_update_request.go
diff --git a/pkg/gen/primeclient/sit_address_update/sit_address_update_client.go b/pkg/gen/primeclient/sit_address_update/sit_address_update_client.go
diff --git a/swagger-def/prime.yaml b/swagger-def/prime.yaml
@@ -35,6 +35,8 @@ tags:
       All weight entered should be in *pounds* and no other unit of measurement.
   - name: sitAddressUpdate
     description: |
+      **THIS ENDPOINT WILL BE DEPRECATED ON AUGUST 5TH, 2024 - REFER TO DESCRIPTION FOR DETAILS**
+
       A **sitAddressUpdate** is submitted when the prime or office user wishes to update the final address for an
       approved service item. sitAddressUpdates with a distance less than or equal to 50 miles will be automatically
       approved while a distance greater than 50 miles will typically require office user approval.
@@ -1361,6 +1363,11 @@ paths:
         **Limitations:**
         The update can be requested for APPROVED SIT service items only.
         Only ONE request is allowed per approved SIT service item.
+
+        **DEPRECATION ON AUGUST 5TH, 2024**
+        Following deprecation, when updating a service item's final delivery address, you will need to update the shipment's destination address. This will update the destination SIT service items' final delivery address upon approval.
+        For `APPROVED` shipments, you can use [updateShipmentDestinationAddress](#mtoShipment/updateShipmentDestinationAddress)
+        For shipments in any other status, you can use [updateMTOShipmentAddress](#mtoShipment/updateMTOShipmentAddress)
       operationId: createSITAddressUpdateRequest
       tags:
         - sitAddressUpdate

diff --git a/swagger/prime.yaml b/swagger/prime.yaml
@@ -83,6 +83,10 @@ tags:
       All weight entered should be in *pounds* and no other unit of measurement.
   - name: sitAddressUpdate
     description: >
+      **THIS ENDPOINT WILL BE DEPRECATED ON AUGUST 5TH, 2024 - REFER TO
+      DESCRIPTION FOR DETAILS**
+
+
       A **sitAddressUpdate** is submitted when the prime or office user wishes
       to update the final address for an
 
@@ -1646,6 +1650,20 @@ paths:
         The update can be requested for APPROVED SIT service items only.
 
         Only ONE request is allowed per approved SIT service item.
+
+
+        **DEPRECATION ON AUGUST 5TH, 2024**
+
+        Following deprecation, when updating a service item's final delivery
+        address, you will need to update the shipment's destination address.
+        This will update the destination SIT service items' final delivery
+        address upon approval.
+
+        For `APPROVED` shipments, you can use
+        [updateShipmentDestinationAddress](#mtoShipment/updateShipmentDestinationAddress)
+
+        For shipments in any other status, you can use
+        [updateMTOShipmentAddress](#mtoShipment/updateMTOShipmentAddress)
       operationId: createSITAddressUpdateRequest
       tags:
         - sitAddressUpdate