chore(docs): Generated API Reference (#4205)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-05-31 17:10:23 +03:00
committed by GitHub
parent 5c8ef2d370
commit 274056a38d
7 changed files with 215 additions and 46 deletions

View File

@@ -8,20 +8,7 @@ properties:
inventory_items:
type: array
items:
allOf:
- $ref: ./InventoryItemDTO.yaml
- type: object
properties:
location_levels:
type: array
items:
allOf:
- $ref: ./InventoryLevelDTO.yaml
variants:
type: array
items:
allOf:
- $ref: ./ProductVariant.yaml
$ref: ./DecoratedInventoryItemDTO.yaml
count:
type: integer
description: The total number of items available

View File

@@ -8,7 +8,7 @@ properties:
reservations:
type: array
items:
$ref: ./ReservationItemDTO.yaml
$ref: ./ExtendedReservationItem.yaml
count:
type: integer
description: The total number of items available

View File

@@ -0,0 +1,22 @@
type: object
allOf:
- $ref: ./InventoryItemDTO.yaml
- type: object
required:
- stocked_quantity
- reserved_quantity
properties:
location_levels:
type: array
items:
$ref: ./InventoryLevelDTO.yaml
variants:
type: array
items:
$ref: ./ProductVariant.yaml
stocked_quantity:
type: number
description: The total quantity of the item in stock across levels
reserved_quantity:
type: number
description: The total quantity of the item available across levels

View File

@@ -0,0 +1,11 @@
type: object
allOf:
- $ref: ./ReservationItemDTO.yaml
- type: object
properties:
line_item:
description: optional line item
$ref: ./LineItem.yaml
inventory_item:
description: inventory item from inventory module
$ref: ./InventoryItemDTO.yaml