docs: generate API reference for 2.10.0 (#13330)

2025-08-28 20:05:37 +03:00
1 parent 494d28ebe4
commit 5c6e172c61
@@ -9,7 +9,6 @@
 *   - shipping_profile_id
 *   - price_type
 *   - provider_id
- *   - type
 *   - prices
 * properties:
 *   name:
@@ -82,6 +81,10 @@
 *     description: The shipping option's rules.
 *     items:
 *       $ref: "#/components/schemas/AdminCreateShippingOptionRule"
+ *   type_id:
+ *     type: string
+ *     title: type_id
+ *     description: The ID of the shipping option type that this shipping option belongs to.
 * 
 */

@@ -24,6 +24,10 @@
 *     description: The associated inventory item's ID.
 *   inventory:
 *     $ref: "#/components/schemas/AdminInventoryItem"
+ *   required_quantity:
+ *     type: number
+ *     title: required_quantity
+ *     description: The inventory item's required quantity.
 * 
 */

@@ -0,0 +1,26 @@
+/**
+ * @schema AdminShippingOptionTypeDeleteResponse
+ * type: object
+ * description: The response returned after deleting a shipping option type.
+ * x-schemaName: AdminShippingOptionTypeDeleteResponse
+ * required:
+ *   - id
+ *   - object
+ *   - deleted
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The shipping option type's ID.
+ *   object:
+ *     type: string
+ *     title: object
+ *     description: The name of the deleted object.
+ *     default: shipping_option_type
+ *   deleted:
+ *     type: boolean
+ *     title: deleted
+ *     description: Whether the Shipping Option Type was deleted.
+ * 
+*/
+
@@ -0,0 +1,36 @@
+/**
+ * @schema AdminShippingOptionTypeListResponse
+ * type: object
+ * description: The paginated list of shipping option types.
+ * x-schemaName: AdminShippingOptionTypeListResponse
+ * required:
+ *   - limit
+ *   - offset
+ *   - count
+ *   - shipping_option_types
+ * properties:
+ *   limit:
+ *     type: number
+ *     title: limit
+ *     description: The maximum number of items returned.
+ *   offset:
+ *     type: number
+ *     title: offset
+ *     description: The number of items skipped before returning the results.
+ *   count:
+ *     type: number
+ *     title: count
+ *     description: The total number of items.
+ *   estimate_count:
+ *     type: number
+ *     title: estimate_count
+ *     description: The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.
+ *     x-featureFlag: index_engine
+ *   shipping_option_types:
+ *     type: array
+ *     description: The list of shipping option types.
+ *     items:
+ *       $ref: "#/components/schemas/AdminShippingOptionType"
+ * 
+*/
+
@@ -0,0 +1,13 @@
+/**
+ * @schema AdminShippingOptionTypeResponse
+ * type: object
+ * description: The shipping option type's details.
+ * x-schemaName: AdminShippingOptionTypeResponse
+ * required:
+ *   - shipping_option_type
+ * properties:
+ *   shipping_option_type:
+ *     $ref: "#/components/schemas/AdminShippingOptionType"
+ * 
+*/
+