chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
co-authored by
olivermrbl
Shahed Nasser
parent
efdea04963
commit
658339767b
@@ -1,11 +1,18 @@
|
||||
get:
|
||||
operationId: GetRegions
|
||||
summary: List Regions
|
||||
description: Retrieves a list of Regions.
|
||||
description: >-
|
||||
Retrieve a list of regions. The regions can be filtered by fields such as
|
||||
`created_at`. The regions can also be paginated. This endpoint is useful to
|
||||
show the customer all available regions to choose from.
|
||||
externalDocs:
|
||||
description: How to use regions in a storefront
|
||||
url: >-
|
||||
https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
|
||||
parameters:
|
||||
- in: query
|
||||
name: offset
|
||||
description: How many regions to skip in the result.
|
||||
description: The number of regions to skip when retrieving the regions.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
@@ -17,7 +24,7 @@ get:
|
||||
default: 100
|
||||
- in: query
|
||||
name: created_at
|
||||
description: Date comparison for when resulting regions were created.
|
||||
description: Filter by a creation date range.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
@@ -39,7 +46,7 @@ get:
|
||||
format: date
|
||||
- in: query
|
||||
name: updated_at
|
||||
description: Date comparison for when resulting regions were updated.
|
||||
description: Filter by an update date range.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in New Issue
Block a user