kiolyn-api-specs
Version:
96 lines (92 loc) • 2.28 kB
YAML
/area/{storeid}:
get:
tags:
- area
description: Return all the customers belong to given store
operationId: listAreas
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
200:
description: list of area
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Area'
post:
tags:
- area
description: Update/Create area
operationId: saveArea
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Area'
responses:
$ref#4xx: './responses/4xx.yaml'
$ref#upsert: './responses/20x-upsert.yaml'
/area/{storeid}/{id}:
get:
tags:
- area
description: Return the area with given id
operationId: loadArea
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
- $ref#id: './parameters/objectid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
200:
description: area detail
content:
application/json:
schema:
type: object
properties:
value:
$ref: '#/components/schemas/Area'
delete:
tags:
- area
description: Delete a area with given id
operationId: deleteArea
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
- $ref#id: './parameters/objectid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
$ref#204: './responses/204.yaml'
/area/{id}/export-pdf-table:
get:
tags:
- area
description: return pdf
operationId: getAreaTablePdf
security:
- bearerAuth: []
parameters:
- $ref#id: "./parameters/objectid.yaml"
responses:
$ref#4xx: "./responses/4xx.yaml"
200:
description: template as pdf
content:
application/pdf:
schema:
type: string
format: binary