22f30f54fd
* remove everything v1 and make v2 default * move main v2 rewrites to book * move rewrites to book + other fixes
71 lines
1.8 KiB
YAML
71 lines
1.8 KiB
YAML
get:
|
|
operationId: GetRegions
|
|
summary: List Regions
|
|
description: >-
|
|
Retrieve a list of regions. The regions can be filtered by fields such as
|
|
`id`. The regions can also be sorted or paginated.
|
|
x-authenticated: true
|
|
parameters: []
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
- jwt_token: []
|
|
x-codeSamples:
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_regions/get.sh
|
|
tags:
|
|
- Regions
|
|
responses:
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema: {}
|
|
post:
|
|
operationId: PostRegions
|
|
summary: Create Region
|
|
description: Create a region.
|
|
x-authenticated: true
|
|
parameters: []
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
- jwt_token: []
|
|
x-codeSamples:
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_regions/post.sh
|
|
tags:
|
|
- Regions
|
|
responses:
|
|
'400':
|
|
$ref: ../components/responses/400_error.yaml
|
|
'401':
|
|
$ref: ../components/responses/unauthorized.yaml
|
|
'404':
|
|
$ref: ../components/responses/not_found_error.yaml
|
|
'409':
|
|
$ref: ../components/responses/invalid_state_error.yaml
|
|
'422':
|
|
$ref: ../components/responses/invalid_request_error.yaml
|
|
'500':
|
|
$ref: ../components/responses/500_error.yaml
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema: {}
|