kiolyn-api-specs
Version:
74 lines (73 loc) • 1.87 kB
YAML
/screen/{storeid}:
get:
tags:
- screen
description: Return all the screens belong to given store
operationId: listScreens
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
200:
description: list of screen
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Screen'
post:
tags:
- screen
description: Update or Create screen
operationId: saveScreen
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Screen'
responses:
$ref#4xx: './responses/4xx.yaml'
$ref#upsert: './responses/20x-upsert.yaml'
/screen/{storeid}/{id}:
get:
tags:
- screen
description: Return the screen with given id
operationId: loadScreen
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
- $ref#id: './parameters/objectid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
200:
description: screen detail
content:
application/json:
schema:
type: object
properties:
value:
$ref: '#/components/schemas/Screen'
delete:
tags:
- screen
description: Delete a screen with given id
operationId: deleteScreen
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
- $ref#id: './parameters/objectid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
$ref#204: './responses/204.yaml'