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

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

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-03-27 18:24:22 +01:00
committed by GitHub
parent 9766266b97
commit 8e3e49fbbf
14 changed files with 934 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
www/apps/api-reference/specs/admin/paths/admin_collections.yaml
View File

@@ -34,6 +34,11 @@ get:
description: a term to search collections by their title or handle.
schema:
type: string
- in: query
name: order
description: A field to sort-order the retrieved collections by.
schema:
type: string
- in: query
name: discount_condition_id
description: Filter collections by a discount condition ID associated with them.

7
www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml
View File

@@ -125,6 +125,13 @@ get:
customer groups.
schema:
type: string
- in: query
name: fields
description: >-
Comma-separated fields that should be included in the returned customer
groups.
schema:
type: string
x-codegen:
method: list
queryParams: AdminGetCustomerGroupsParams

63
www/apps/api-reference/specs/admin/paths/admin_customers.yaml
View File

@@ -22,7 +22,14 @@ get:
name: expand
description: >-
Comma-separated relations that should be expanded in the returned
customer.
customers.
schema:
type: string
- in: query
name: fields
description: >-
Comma-separated fields that should be included in the returned
customers.
schema:
type: string
- in: query
@@ -30,6 +37,16 @@ get:
description: term to search customers' email, first_name, and last_name fields.
schema:
type: string
- in: query
name: has_account
description: Filter customers by whether they have an account.
schema:
type: boolean
- in: query
name: order
description: A field to sort-order the retrieved customers by.
schema:
type: string
- in: query
name: groups
style: form
@@ -39,6 +56,50 @@ get:
type: array
items:
type: string
- in: query
name: created_at
description: Filter by a creation date range.
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: updated_at
description: Filter by an update date range.
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
x-codegen:
method: list
queryParams: AdminGetCustomersParams

49
www/apps/api-reference/specs/admin/paths/admin_discounts.yaml
View File

@@ -59,6 +59,55 @@ get:
discount.
schema:
type: string
- in: query
name: order
description: A discount field to sort-order the retrieved discounts by.
schema:
type: string
- in: query
name: created_at
description: Filter by a creation date range.
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: updated_at
description: Filter by an update date range.
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
x-codegen:
method: list
queryParams: AdminGetDiscountsParams

71
www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml
View File

@@ -25,6 +25,77 @@ get:
order's cart
schema:
type: string
- in: query
name: order
description: Field to sort retrieved draft orders by.
schema:
type: string
- in: query
name: expand
description: A comma-separated list of fields to expand.
schema:
type: string
- in: query
name: fields
description: A comma-separated list of fields to include in the response.
schema:
type: string
- in: query
name: created_at
description: Filter by a creation date range.
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: updated_at
description: Filter by an update date range.
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: status
style: form
explode: false
description: Filter by status
schema:
type: array
items:
type: string
enum:
- open
- completed
x-codegen:
method: list
queryParams: AdminGetDraftOrdersParams

5
www/apps/api-reference/specs/admin/paths/admin_gift-cards.yaml
View File

@@ -23,6 +23,11 @@ get:
description: a term to search gift cards' code or display ID
schema:
type: string
- in: query
name: order
description: A gift card field to sort-order the retrieved gift cards by.
schema:
type: string
x-codegen:
method: list
queryParams: AdminGetGiftCardsParams

5
www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml
View File

@@ -40,6 +40,11 @@ get:
description: term to search inventory item's sku, title, and description.
schema:
type: string
- in: query
name: order
description: Field to sort-order inventory items by.
schema:
type: string
- in: query
name: location_id
style: form

2
www/apps/api-reference/specs/admin/paths/admin_orders.yaml
View File

@@ -217,7 +217,7 @@ get:
type: string
- in: query
name: order
description: A order field to sort-order the retrieved orders by.
description: Field to sort retrieved orders by.
schema:
type: string
x-codegen:

14
www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml
View File

@@ -21,9 +21,17 @@ get:
type: string
- in: query
name: id
description: Filter by product ID
style: form
explode: false
description: Filter by product IDs.
schema:
type: string
oneOf:
- type: string
description: ID of the product.
- type: array
items:
type: string
description: ID of a product.
- in: query
name: status
description: Filter by product status
@@ -79,7 +87,7 @@ get:
name: is_giftcard
description: A boolean value to filter by whether the product is a gift card or not.
schema:
type: string
type: boolean
- in: query
name: type
description: Filter product type.

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

@@ -4,11 +4,6 @@ get:
description: >
Retrieve a list of Product Variants associated with a Product. The variants
can be paginated.
By default, each variant will only have the `id` and `variant_id` fields.
You can use the `expand` and `fields` request parameters to retrieve more
fields or relations.
x-authenticated: true
parameters:
- in: path
@@ -17,6 +12,11 @@ get:
description: ID of the product.
schema:
type: string
- in: query
name: id
description: IDs to filter product variants by.
schema:
type: string
- in: query
name: fields
description: >-
@@ -45,6 +45,74 @@ get:
schema:
type: integer
default: 100
- in: query
name: q
description: Search term to search product variants' title, sku, and products' title.
schema:
type: string
- 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: created_at
description: Filter by a creation date range.
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: updated_at
description: Filter by an update date range.
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
x-codegen:
method: listVariants
queryParams: AdminGetProductsVariantsParams

74
www/apps/api-reference/specs/admin/paths/admin_publishable-api-keys.yaml
View File

@@ -40,6 +40,80 @@ get:
publishable API keys.
schema:
type: string
- in: query
name: order
description: A field to sort-order the retrieved publishable API keys by.
schema:
type: string
- in: query
name: created_at
required: false
description: Filter by a creation date range.
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: updated_at
required: false
description: Filter by a update date range.
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: revoked_at
required: false
description: Filter by a revocation date range.
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
x-codegen:
method: list
queryParams: GetPublishableApiKeysParams

76
www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml
View File

@@ -27,6 +27,72 @@ get:
description: Filter by code.
schema:
type: string
- in: query
name: created_at
description: Filter by a creation date range.
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: updated_at
description: Filter by an update date range.
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: deleted_at
description: Filter by a deletion date range.
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: rate
style: form
@@ -49,6 +115,16 @@ get:
gte:
type: number
description: filter by rates greater than or equal to this number
- in: query
name: q
description: Term used to search tax rates by name.
schema:
type: string
- in: query
name: order
description: A tax rate field to sort-order the retrieved tax rates by.
schema:
type: string
- in: query
name: offset
description: The number of tax rates to skip when retrieving the tax rates.