chore(docs): Updated API Reference (v2) (#9437)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
co-authored by
Shahed Nasser
parent
97c193be1b
commit
21badd069d
@@ -9,7 +9,6 @@ required:
|
||||
- external_id
|
||||
- description
|
||||
- inventory_item_id
|
||||
- inventory_item
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
@@ -18,11 +17,11 @@ properties:
|
||||
line_item_id:
|
||||
type: string
|
||||
title: line_item_id
|
||||
description: The reservation's line item id.
|
||||
description: The ID of the line item this reservation is for.
|
||||
location_id:
|
||||
type: string
|
||||
title: location_id
|
||||
description: The reservation's location id.
|
||||
description: The ID of the location the quantity is reserved from.
|
||||
quantity:
|
||||
type: number
|
||||
title: quantity
|
||||
@@ -30,7 +29,7 @@ properties:
|
||||
external_id:
|
||||
type: string
|
||||
title: external_id
|
||||
description: The reservation's external id.
|
||||
description: An ID in an external system
|
||||
description:
|
||||
type: string
|
||||
title: description
|
||||
@@ -38,29 +37,28 @@ properties:
|
||||
inventory_item_id:
|
||||
type: string
|
||||
title: inventory_item_id
|
||||
description: The reservation's inventory item id.
|
||||
description: The ID of the inventory item this reservation is associated with.
|
||||
inventory_item:
|
||||
type: object
|
||||
description: The reservation's inventory item.
|
||||
$ref: ./AdminInventoryItem.yaml
|
||||
metadata:
|
||||
type: object
|
||||
description: The reservation's metadata.
|
||||
description: The reservation's metadata, can hold custom key-value pairs.
|
||||
created_by:
|
||||
type: string
|
||||
title: created_by
|
||||
description: The reservation's created by.
|
||||
description: The ID of the user that created this reservation.
|
||||
deleted_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: deleted_at
|
||||
description: The reservation's deleted at.
|
||||
description: The date this reservation was deleted.
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: created_at
|
||||
description: The reservation's created at.
|
||||
description: The date this reservation was created.
|
||||
updated_at:
|
||||
type: string
|
||||
format: date-time
|
||||
title: updated_at
|
||||
description: The reservation's updated at.
|
||||
description: The date this reservation was updated.
|
||||
|
||||
Reference in New Issue
Block a user