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

chore(docs): Updated API Reference (#6831)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-04-02 09:47:04 +00:00
committed by GitHub
parent 9d466717f4
commit 85e5478873
3 changed files with 80 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -17037,6 +17037,28 @@ paths:
description: Filter product variants by whether they are allowed to be backordered or not.
schema:
type: boolean
- in: query
name: inventory_quantity
description: Filter by available inventory quantity
schema:
oneOf:
- type: number
description: a specific number to filter by.
- type: object
description: filter using less and greater than comparisons.
properties:
lt:
type: number
description: filter by inventory quantity less than this number
gt:
type: number
description: filter by inventory quantity greater than this number
lte:
type: number
description: filter by inventory quantity less than or equal to this number
gte:
type: number
description: filter by inventory quantity greater than or equal to this number
- in: query
name: created_at
description: Filter by a creation date range.
@@ -26497,6 +26519,21 @@ paths:
schema:
type: number
default: '100'
- in: query
name: order
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
schema:
type: string
- in: query
name: manage_inventory
description: Filter product variants by whether their inventory is managed or not.
schema:
type: boolean
- in: query
name: allow_backorder
description: Filter product variants by whether they are allowed to be backordered or not.
schema:
type: boolean
- in: query
name: cart_id
style: form

24
www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml
View File

@@ -69,6 +69,30 @@ get:
not.
schema:
type: boolean
- in: query
name: inventory_quantity
description: Filter by available inventory quantity
schema:
oneOf:
- type: number
description: a specific number to filter by.
- type: object
description: filter using less and greater than comparisons.
properties:
lt:
type: number
description: filter by inventory quantity less than this number
gt:
type: number
description: filter by inventory quantity greater than this number
lte:
type: number
description: filter by inventory quantity less than or equal to this number
gte:
type: number
description: >-
filter by inventory quantity greater than or equal to this
number
- in: query
name: created_at
description: Filter by a creation date range.

19
www/apps/api-reference/specs/admin/paths/admin_variants.yaml
View File

@@ -47,6 +47,25 @@ get:
schema:
type: number
default: '100'
- in: query
name: order
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
schema:
type: string
- in: query
name: manage_inventory
description: Filter product variants by whether their inventory is managed or not.
schema:
type: boolean
- in: query
name: allow_backorder
description: >-
Filter product variants by whether they are allowed to be backordered or
not.
schema:
type: boolean
- in: query
name: cart_id
style: form