kiolyn-api-specs
Version:
155 lines (153 loc) • 4.99 kB
YAML
openapi: '3.0.0'
info:
title: Kiolyn POS API
description: Kiolyn POS API
contact:
name: Chinh Nguyen
url: https://willbe.vn
email: chinh@willbe.vn
license:
name: Copyright 2018 of ChaChaPOS INc.
url: https://kiolyn.com/copyright
version: v2
servers:
- url: https://api-staging.kiolyn.com
description: Staging API Server
- url: https://api-production.kiolyn.com
description: Production API Server
tags:
- name: meta
description: API info related API.
- name: user
description: User authentication API.
- name: password
description: Password related (reset password, request new password, etc.) API.
- name: store
description: Store related functions.
- name: merchant
description: Merchant related functions
- name: employee
description: Employee related functions
- name: customer
description: Customer related functions
- name: giftcard
description: Gift card related functions
- name: area
description: Area related functions
- name: category
description: Category related functions
- name: item
description: Item related functions
- name: modifier
description: Modifier related functions
- name: station
description: Station related functions
- name: ccdevice
description: CC Device related functions
- name: printer
description: Printer related functions
- name: screen
description: Screen related functions
- name: kiosk
description: Kiosk related functions
- name: settings
description: Settings related functions
- name: image
description: Image related functions
- name: maps
description: Maps related functions
- name: shopItem
description: Shop item related functions
- name: shopOrder
description: Shop order related functions
- name: promoCode
description: Promo code related functions
- name: kitchenDisplay
description: Kitchen display related functions
- name: promotion
description: Promotion related functions
- name: delivery
description: Delivery related functions
- name: menuTemplate
description: Menu template related functions
- name: kitchenReceiptTemplate
description: Kitchen receipt template related functions
- name: order
description: Order template related functions
- name: statusBoard
description: status board related functions
- name: audio
description: audio related functions
- name: auth
description: Auth related functions
- name: report
description: Report related functions
- name: onlineOrder
description: Online Order related functions
- name: superAdmin
description: Super Admin Account Related functions
- name: admin
description: Admin Account Related functions
- name: appSettings
description: App Settings Related functions
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
$ref#model: './specs/model.yaml'
$ref#user: './specs/user-model.yaml'
$ref#password: './specs/password-model.yaml'
paths:
$ref#meta: './specs/meta.yaml'
$ref#image: './specs/image.yaml'
$ref#user: './specs/user.yaml'
$ref#password: './specs/password.yaml'
$ref#merchant: './specs/merchant.yaml'
$ref#store: './specs/store.yaml'
$ref#employee: './specs/employee.yaml'
$ref#customer: './specs/customer.yaml'
$ref#giftcard: './specs/giftcard.yaml'
$ref#gcgroup: './specs/gcgroup.yaml'
$ref#area: './specs/area.yaml'
$ref#category: './specs/category.yaml'
$ref#item: './specs/item.yaml'
$ref#modifier: './specs/modifier.yaml'
$ref#station: './specs/station.yaml'
$ref#ccdevice: './specs/ccdevice.yaml'
$ref#printer: './specs/printer.yaml'
$ref#settings: './specs/settings.yaml'
$ref#sadmins: './specs/sadmin.yaml'
$ref#ordering: './specs/app/ordering.yaml'
$ref#screen: './specs/screen.yaml'
$ref#app-screen: './specs/app/screen.yaml'
$ref#kiosk: './specs/app/kiosk.yaml'
$ref#ffd: './specs/app/ffd.yaml'
$ref#maps: './specs/app/maps.yaml'
$ref#shop-item: './specs/shop-item.yaml'
$ref#shop-order: './specs/shop-order.yaml'
$ref#promocode: './specs/promocode.yaml'
$ref#gallery: './specs/gallery.yaml'
$ref#shop: './specs/app/shop.yaml'
$ref#kitchen-display: './specs/kitchen-display.yaml'
$ref#promotion: './specs/promotion.yaml'
$ref#delivery: './specs/delivery.yaml'
$ref#menu-template: './specs/menu-template.yaml'
$ref#kitchen-receipt: './specs/kitchen-receipt.yaml'
$ref#order: './specs/order.yaml'
$ref#audio: './specs/app/audio.yaml'
$ref#statusboard: './specs/app/statusboard.yaml'
$ref#auth: './specs/app/auth.yaml'
$ref#admin: './specs/admin.yaml'
$ref#app-settings: './specs/app-settings.yaml'
$ref#billing: './specs/billing.yaml'
$ref#report: './specs/report.yaml'
$ref#online-order: './specs/online-order.yaml'
$ref#refund-code: './specs/refund-code.yaml'
$ref#activation: './specs/activation.yaml'
$ref#invoice: './specs/invoice.yaml'
$ref#printtpl: './specs/printtpl.yaml'
$ref#partner: './specs/partner.yaml'
$ref#ccpoint: './specs/ccpoint.yaml'