kiolyn-api-specs
Version:
75 lines (73 loc) • 1.94 kB
YAML
/promotion/{storeid}:
get:
tags:
- promotion
description: Return all the promotions belong to given store
operationId: listPromotions
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
200:
description: list of promotion
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Promotion'
post:
tags:
- promotion
description: Update/Create promotion
operationId: savePromotion
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Promotion'
responses:
$ref#4xx: './responses/4xx.yaml'
$ref#upsert: './responses/20x-upsert.yaml'
/promotion/{storeid}/{id}:
get:
tags:
- promotion
description: Return the promotion with given id
operationId: loadPromotion
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
- $ref#promotionid: './parameters/objectid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
200:
description: promotion detail
content:
application/json:
schema:
type: object
properties:
value:
$ref: '#/components/schemas/Promotion'
delete:
tags:
- promotion
description: Delete an promotion with given id
operationId: deletePromotion
security:
- bearerAuth: []
parameters:
- $ref#storeid: './parameters/storeid.yaml'
- $ref#promotionid: './parameters/objectid.yaml'
responses:
$ref#4xx: './responses/4xx.yaml'
$ref#204: './responses/204.yaml'