Files
medusa-store/docs/api/admin/paths/regions_{id}.yaml
2023-02-09 09:50:55 +02:00

147 lines
3.6 KiB
YAML

delete:
operationId: DeleteRegionsRegion
summary: Delete a Region
description: Deletes a Region.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Region.
schema:
type: string
x-codegen:
method: delete
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions_{id}/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions_{id}/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Region
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminRegionsDeleteRes.yaml
'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
get:
operationId: GetRegionsRegion
summary: Get a Region
description: Retrieves a Region.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Region.
schema:
type: string
x-codegen:
method: retrieve
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions_{id}/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions_{id}/get.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Region
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminRegionsRes.yaml
'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
post:
operationId: PostRegionsRegion
summary: Update a Region
description: Updates a Region
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Region.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostRegionsRegionReq.yaml
x-codegen:
method: update
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/regions_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/regions_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Region
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminRegionsRes.yaml
'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