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

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

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-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
docs/api/admin/paths/admin_regions.yaml
View File

@@ -1,7 +1,9 @@
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
x-authenticated: true
parameters:
- in: query
@@ -10,38 +12,83 @@ get:
type: integer
default: 50
required: false
description: limit the number of regions in response
description: Limit the number of regions returned.
- in: query
name: offset
schema:
type: integer
default: 0
required: false
description: Offset of regions in response (used for pagination)
description: The number of regions to skip when retrieving the regions.
- in: query
name: created_at
required: false
description: Filter by a creation date range.
schema:
type: object
required: false
description: >-
Date comparison for when resulting region was created, i.e. less than,
greater than etc.
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 an update date range.
schema:
type: object
required: false
description: >-
Date comparison for when resulting region was updated, i.e. less than,
greater than etc.
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
required: false
description: Filter by a deletion date range.
schema:
type: object
required: false
description: >-
Date comparison for when resulting region was deleted, i.e. less than,
greater than etc.
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: AdminGetRegionsParams
@@ -81,7 +128,7 @@ get:
post:
operationId: PostRegions
summary: Create a Region
description: Creates a Region
description: Create a Region.
x-authenticated: true
requestBody:
content: