Update endpoint description

transcom · Jul 3, 2023 · c690df0 · c690df0
1 parent c0d6c33
commit c690df0
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 6 deletions.
diff --git a/pkg/gen/primeapi/embedded_spec.go b/pkg/gen/primeapi/embedded_spec.go
diff --git a/pkg/gen/primeapi/primeoperations/mto_shipment/create_non_s_i_t_address_update_request.go b/pkg/gen/primeapi/primeoperations/mto_shipment/create_non_s_i_t_address_update_request.go
diff --git a/pkg/gen/primeclient/mto_shipment/mto_shipment_client.go b/pkg/gen/primeclient/mto_shipment/mto_shipment_client.go
diff --git a/swagger-def/prime.yaml b/swagger-def/prime.yaml
@@ -534,7 +534,8 @@ paths:
       summary: createNonSITAddressUpdateRequest
       description: |
         ### Functionality
-        This endpoint is used so the Prime can request an **update** for the destination address on an MTO Shipment.
+        This endpoint is used so the Prime can request an **update** for the destination address on an MTO Shipment,
+        after the destination address has already been approved.
         This does not change addresses on SIT service items.
         Address updates will be automatically approved unless they change:
           - the service area

diff --git a/swagger/prime.yaml b/swagger/prime.yaml
@@ -629,7 +629,9 @@ paths:
         ### Functionality
 
         This endpoint is used so the Prime can request an **update** for the
-        destination address on an MTO Shipment.
+        destination address on an MTO Shipment,
+
+        after the destination address has already been approved.
 
         This does not change addresses on SIT service items.