chore(docs): Updated API Reference (v2) (#8609)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
4bd0917aed
commit
b23ddcdde8
@@ -216,11 +216,21 @@ get:
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The region's $and.
|
||||
items:
|
||||
type: object
|
||||
title: $and
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
schema:
|
||||
type: array
|
||||
description: The region's $or.
|
||||
items:
|
||||
type: object
|
||||
title: $or
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -233,6 +243,41 @@ get:
|
||||
tags:
|
||||
- Regions
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- limit
|
||||
- offset
|
||||
- count
|
||||
properties:
|
||||
limit:
|
||||
type: number
|
||||
title: limit
|
||||
description: The region's limit.
|
||||
offset:
|
||||
type: number
|
||||
title: offset
|
||||
description: The region's offset.
|
||||
count:
|
||||
type: number
|
||||
title: count
|
||||
description: The region's count.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
required:
|
||||
- regions
|
||||
properties:
|
||||
regions:
|
||||
type: array
|
||||
description: The region's regions.
|
||||
items:
|
||||
$ref: ../components/schemas/AdminRegion.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -362,6 +407,12 @@ post:
|
||||
tags:
|
||||
- Regions
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminRegionResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -374,3 +425,4 @@ post:
|
||||
$ref: ../components/responses/invalid_request_error.yaml
|
||||
'500':
|
||||
$ref: ../components/responses/500_error.yaml
|
||||
x-workflow: createRegionsWorkflow
|
||||
|
||||
Reference in New Issue
Block a user