oas: [2/n] improve schema oas (#9040)

This commit is contained in:
Shahed Nasser
2024-09-06 18:53:07 +03:00
committed by GitHub
parent 0482b7751d
commit 7a80593b68
20 changed files with 168 additions and 204 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminCreateReservation
* type: object
* description: SUMMARY
* description: The reservation's details.
* x-schemaName: AdminCreateReservation
* required:
* - location_id
@@ -11,26 +11,26 @@
* 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 created 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.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* description: The ID of the inventory item associated with the line item's variant.
* quantity:
* type: number
* title: quantity
* description: The reservation's quantity.
* description: The reserved quantity.
* description:
* type: string
* title: description
* description: The reservation's description.
* metadata:
* type: object
* description: The reservation's metadata.
* description: The reservation's metadata, used to store custom key-value pairs.
*
*/