docs: generate API reference for 2.10.0 (#13330)
This commit is contained in:
@@ -7,7 +7,6 @@ required:
|
||||
- shipping_profile_id
|
||||
- price_type
|
||||
- provider_id
|
||||
- type
|
||||
- prices
|
||||
properties:
|
||||
name:
|
||||
@@ -86,3 +85,7 @@ properties:
|
||||
description: The shipping option's rules.
|
||||
items:
|
||||
$ref: ./AdminCreateShippingOptionRule.yaml
|
||||
type_id:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The ID of the shipping option type that this shipping option belongs to.
|
||||
|
||||
@@ -22,3 +22,7 @@ properties:
|
||||
description: The associated inventory item's ID.
|
||||
inventory:
|
||||
$ref: ./AdminInventoryItem.yaml
|
||||
required_quantity:
|
||||
type: number
|
||||
title: required_quantity
|
||||
description: The inventory item's required quantity.
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
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,33 @@
|
||||
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: ./AdminShippingOptionType.yaml
|
||||
@@ -0,0 +1,8 @@
|
||||
type: object
|
||||
description: The shipping option type's details.
|
||||
x-schemaName: AdminShippingOptionTypeResponse
|
||||
required:
|
||||
- shipping_option_type
|
||||
properties:
|
||||
shipping_option_type:
|
||||
$ref: ./AdminShippingOptionType.yaml
|
||||
Reference in New Issue
Block a user