swag-wallets/api/privdoc/spec/swagger.yaml
Andrew Mayorov 0ba011b839
CAPI-262: Make up swagger repo w/ basic wallet api (#1)
* CAPI-262: Make up swagger repo w/ basic wallet api
* CAPI-262: Design identity levels and challenges
* CAPI-262: Allow to list wallets and identites
* CAPI-292: Switch to Redoc 2.x
* CAPI-262: Draft outputs and withdrawals
2018-06-12 19:50:45 +03:00

62 lines
1.5 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

swagger: '2.0'
info:
version: '0.0.1'
title: RBKmoney Private Document API
description: >
RBKmoney Private Document API служит для токенизации чувствительных данных
персональных документов пользователей.
termsOfService: http://rbk.money/
contact:
name: RBKmoney support team
email: support@rbk.money
url: https://rbk.money
host: api.rbk.money
basePath: /privdoc/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:
BadRequest:
description: Недопустимые для операции входные данные
schema:
$ref: '#/definitions/BadRequest'
parameters:
requestID:
name: X-Request-ID
in: header
description: Уникальный идентификатор запроса к системе
required: true
type: string
maxLength: 32
minLength: 1
tags:
- name: Private Documents
x-displayName: Персональные документы
description: ""