rename paths, added DocumentType

This commit is contained in:
malkoas 2021-01-11 17:23:15 +03:00
parent 1d8155cf0c
commit 1e9eed3360
5 changed files with 60 additions and 10 deletions

View File

@ -0,0 +1,21 @@
type: object
required:
- documentTypeRef
- name
- description
properties:
documentTypeRef:
description: Идентификатор типа документа
type: string
maxLength: 40
minLength: 1
name:
description: Название типа документа
type: string
maxLength: 40
minLength: 1
description:
description: Описание типа документа
type: string
maxLength: 128
minLength: 1

View File

@ -16,14 +16,18 @@ info:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
paths:
/category:
$ref: ./paths/category.yaml
/сashRegisterProvider:
$ref: ./paths/сashRegisterProvider.yaml
/categories:
$ref: ./paths/categories.yaml
/сashRegisterProviders:
$ref: ./paths/сashRegisterProviders.yaml
/documentTypes:
$ref: ./paths/documentTypes.yaml
tags:
- name: category
- name: categories
x-displayName: Категории
- name: сashRegisterProvider
- name: сashRegisterProviders
x-displayName: Провайдеры чеков
- name: documentTypes
x-displayName: Типы документа
servers:
- url: 'https://api.rbk.money/v1/dominant/cache'

View File

@ -1,8 +1,8 @@
get:
summary: Получить список категорий
tags:
- category
operationId: getCategory
- categories
operationId: getCategories
responses:
'200':
description: Список категорий

View File

@ -0,0 +1,25 @@
get:
summary: Получить список типов документа
tags:
- documentTypes
operationId: getDocumentTypes
responses:
'200':
description: Список типов документа
content:
application/json:
schema:
type: object
required:
- results
properties:
results:
type: array
items:
$ref: '../components/schemas/DocumentType.yaml'
'400':
$ref: '../components/responses/DefaultLogicError.yaml'
'401':
description: Ошибка авторизации
'404':
description: Заданный ресурс не найден

View File

@ -1,8 +1,8 @@
get:
summary: Получить список провайдеров чеков
tags:
- сashRegisterProvider
operationId: getCashRegisterProvider
- сashRegisterProviders
operationId: getCashRegisterProviders
responses:
'200':
description: Список провайдеров