Mark variant_id and quantity as deprecated creating api shipments

nebulab · May 30, 2022 · 6b8004b · 6b8004b
1 parent 6127486
commit 6b8004b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/api/openapi/solidus-api.oas.yml b/api/openapi/solidus-api.oas.yml
@@ -5579,6 +5579,10 @@ paths:
         Creates a shipment.
 
         Please note that this request can be only performed by users with the `create` permission on the shipment.
+
+        **Deprecation Warning**: Adding items to the shipment via this endpoint
+        is deprecated. Instead, create an empty shipment and populate it with
+        the dedicated endpoint [to add items to the shipment](/docs/solidus/7078dbcf415ac-add-shipment-item).
       operationId: create-shipment
       tags:
         - Shipments
@@ -5594,8 +5598,10 @@ paths:
                   type: integer
                 variant_id:
                   type: integer
+                  deprecated: true
                 quantity:
                   type: integer
+                  deprecated: true
             examples:
               Example:
                 value: