asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

163
docs/api/admin.oas.json
View File

@@ -6353,6 +6353,19 @@
"type": "string"
}
},
{
"in": "query",
"name": "location_id",
"style": "form",
"explode": false,
"description": "Locations ids to search for.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "expand",
@@ -17748,6 +17761,65 @@
}
}
},
{
"in": "query",
"name": "description",
"description": "A param for search reservation descriptions",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"contains": {
"type": "string",
"description": "filter by reservation description containing search string."
},
"starts_with": {
"type": "string",
"description": "filter by reservation description starting with search string."
},
"ends_with": {
"type": "string",
"description": "filter by reservation description ending with search string."
}
}
}
]
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting reservations were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "offset",
@@ -25509,36 +25581,7 @@
"inventory_items": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/InventoryItemDTO"
},
{
"type": "object",
"properties": {
"location_levels": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/InventoryLevelDTO"
}
]
}
},
"variants": {
"type": "array",
"items": {
"allOf": [
{
"$ref": "#/components/schemas/ProductVariant"
}
]
}
}
}
}
]
"$ref": "#/components/schemas/DecoratedInventoryItemDTO"
}
},
"count": {
@@ -31178,7 +31221,7 @@
"reservations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReservationItemDTO"
"$ref": "#/components/schemas/ExtendedReservationItem"
}
},
"count": {
@@ -33281,6 +33324,43 @@
}
}
},
"DecoratedInventoryItemDTO": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/InventoryItemDTO"
},
{
"type": "object",
"required": [
"stocked_quantity",
"reserved_quantity"
],
"properties": {
"location_levels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InventoryLevelDTO"
}
},
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariant"
}
},
"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"
}
}
}
]
},
"Discount": {
"title": "Discount",
"description": "Represents a discount that can be applied to a cart for promotional purposes.",
@@ -33987,6 +34067,27 @@
}
}
},
"ExtendedReservationItem": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ReservationItemDTO"
},
{
"type": "object",
"properties": {
"line_item": {
"description": "optional line item",
"$ref": "#/components/schemas/LineItem"
},
"inventory_item": {
"description": "inventory item from inventory module",
"$ref": "#/components/schemas/InventoryItemDTO"
}
}
}
]
},
"ExtendedStoreDTO": {
"allOf": [
{