mirror of
https://github.com/valitydev/swag-questionary-aggr-proxy.git
synced 2024-11-06 08:25:16 +00:00
59 lines
1.4 KiB
YAML
59 lines
1.4 KiB
YAML
swagger: '2.0'
|
||
info:
|
||
version: '0.0.1'
|
||
title: RBKmoney Questionary aggr proxy API
|
||
description: >
|
||
|
||
Proxy service for DaData/KonturFocus API
|
||
|
||
termsOfService: http://rbk.money/
|
||
contact:
|
||
name: RBKmoney support team
|
||
email: support@rbk.money
|
||
url: https://rbk.money
|
||
host: api.rbk.money
|
||
basePath: /questionary-aggr/v0
|
||
schemes:
|
||
- https
|
||
consumes:
|
||
- application/json; charset=utf-8
|
||
produces:
|
||
- application/json; charset=utf-8
|
||
securityDefinitions:
|
||
bearer:
|
||
type: apiKey
|
||
name: Authorization
|
||
in: header
|
||
description: >
|
||
Для аутентификации вызовов мы используем [JWT](https://jwt.io).
|
||
Cоответствующий ключ передается в заголовке.
|
||
|
||
```shell
|
||
Authorization: Bearer {TOKENIZATION|PRIVATE_JWT}
|
||
```
|
||
|
||
security:
|
||
- bearer: []
|
||
|
||
responses:
|
||
NotFound:
|
||
description: Заданный ресурс не найден
|
||
schema:
|
||
$ref: '#/definitions/GeneralError'
|
||
Unauthorized:
|
||
description: Ошибка авторизации
|
||
GeneralError:
|
||
description: Неверные данные
|
||
schema:
|
||
$ref: '#/definitions/GeneralError'
|
||
|
||
parameters:
|
||
requestID:
|
||
name: X-Request-ID
|
||
in: header
|
||
description: Уникальный идентификатор запроса к системе
|
||
required: true
|
||
type: string
|
||
maxLength: 32
|
||
minLength: 1
|