mirror of
https://github.com/valitydev/swag-payments.git
synced 2024-11-06 09:35:22 +00:00
Merge pull request #450 from rbkmoney/ft/ED-276/remove-claims
ED-276: Remove claims from public API
This commit is contained in:
commit
f30afb5670
@ -1,30 +0,0 @@
|
||||
type: object
|
||||
discriminator: status
|
||||
required:
|
||||
- id
|
||||
- revision
|
||||
- createdAt
|
||||
- status
|
||||
- changeset
|
||||
properties:
|
||||
id:
|
||||
description: Идентификатор заявки
|
||||
type: integer
|
||||
format: int64
|
||||
revision:
|
||||
description: Версия заявки
|
||||
type: integer
|
||||
format: int32
|
||||
createdAt:
|
||||
description: Дата создания
|
||||
type: string
|
||||
format: date-time
|
||||
updatedAt:
|
||||
description: Дата изменения
|
||||
type: string
|
||||
format: date-time
|
||||
status:
|
||||
description: Статус заявки
|
||||
type: string
|
||||
changeset:
|
||||
$ref: '#/definitions/ClaimChangeset'
|
@ -1,3 +0,0 @@
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/Claim'
|
@ -1,4 +0,0 @@
|
||||
description: Набор изменений данных участника
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/definitions/PartyModification'
|
@ -1,11 +0,0 @@
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/Claim'
|
||||
- type: object
|
||||
required:
|
||||
- reason
|
||||
properties:
|
||||
reason:
|
||||
description: Причина отклонения заявки
|
||||
type: string
|
||||
maxLength: 1000
|
@ -1,3 +0,0 @@
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/Claim'
|
@ -1,11 +0,0 @@
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: '#/definitions/Claim'
|
||||
- type: object
|
||||
required:
|
||||
- reason
|
||||
properties:
|
||||
reason:
|
||||
description: Причина отзыва заявки
|
||||
type: string
|
||||
maxLength: 1000
|
@ -1,75 +0,0 @@
|
||||
get:
|
||||
description: |
|
||||
Получить список заявок участника, при желании отфильтрованный по значению
|
||||
статуса.
|
||||
operationId: getClaims
|
||||
tags:
|
||||
- Claims
|
||||
parameters:
|
||||
- $ref: '#/parameters/requestID'
|
||||
- $ref: '#/parameters/deadline'
|
||||
- name: claimStatus
|
||||
description: Значение статуса для фильтрации
|
||||
in: query
|
||||
type: string
|
||||
enum:
|
||||
- pending
|
||||
- accepted
|
||||
- denied
|
||||
- revoked
|
||||
responses:
|
||||
'200':
|
||||
description: Список найденных заявок
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/definitions/Claim'
|
||||
'401':
|
||||
$ref: '#/responses/Unauthorized'
|
||||
'400':
|
||||
$ref: '#/responses/DefaultLogicError'
|
||||
|
||||
post:
|
||||
description: |
|
||||
Создать новую заявку с заданным набором изменений и отправить её на
|
||||
премодерацию.
|
||||
operationId: createClaim
|
||||
tags:
|
||||
- Claims
|
||||
parameters:
|
||||
- $ref: '#/parameters/requestID'
|
||||
- $ref: '#/parameters/deadline'
|
||||
- name: claimChangeset
|
||||
in: body
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/ClaimChangeset'
|
||||
responses:
|
||||
'201':
|
||||
description: Заявка создана
|
||||
schema:
|
||||
$ref: '#/definitions/Claim'
|
||||
'401':
|
||||
$ref: '#/responses/Unauthorized'
|
||||
'400':
|
||||
description: Ошибочные данные в заявке
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
properties:
|
||||
code:
|
||||
description: |
|
||||
[Код ошибки](#tag/Error-Codes)
|
||||
type: string
|
||||
enum:
|
||||
- changesetConflict
|
||||
- invalidPartyStatus
|
||||
- invalidChangeset
|
||||
- invalidRequest
|
||||
- invalidDeadline
|
||||
message:
|
||||
description: Человекочитаемое описание ошибки
|
||||
type: string
|
||||
example: Changeset conflict
|
@ -1,21 +0,0 @@
|
||||
get:
|
||||
description: |
|
||||
Получить заявку по её идентификатору.
|
||||
operationId: getClaimByID
|
||||
tags:
|
||||
- Claims
|
||||
parameters:
|
||||
- $ref: '#/parameters/requestID'
|
||||
- $ref: '#/parameters/deadline'
|
||||
- $ref: '#/parameters/claimID'
|
||||
responses:
|
||||
'200':
|
||||
description: Данные заявки
|
||||
schema:
|
||||
$ref: '#/definitions/Claim'
|
||||
'404':
|
||||
$ref: '#/responses/NotFound'
|
||||
'401':
|
||||
$ref: '#/responses/Unauthorized'
|
||||
'400':
|
||||
$ref: '#/responses/DefaultLogicError'
|
@ -1,43 +0,0 @@
|
||||
put:
|
||||
description: Отозвать заявку по её идентификатору.
|
||||
operationId: revokeClaimByID
|
||||
tags:
|
||||
- Claims
|
||||
parameters:
|
||||
- $ref: '#/parameters/requestID'
|
||||
- $ref: '#/parameters/deadline'
|
||||
- $ref: '#/parameters/claimID'
|
||||
- $ref: '#/parameters/claimRevision'
|
||||
- name: reason
|
||||
in: body
|
||||
schema:
|
||||
$ref: '#/definitions/Reason'
|
||||
responses:
|
||||
'204':
|
||||
description: Заявка отозвана
|
||||
'404':
|
||||
$ref: '#/responses/NotFound'
|
||||
'401':
|
||||
$ref: '#/responses/Unauthorized'
|
||||
'400':
|
||||
description: Ошибка отзыва заявки
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
- message
|
||||
properties:
|
||||
code:
|
||||
description: |
|
||||
[Код ошибки](#tag/Error-Codes)
|
||||
type: string
|
||||
enum:
|
||||
- invalidClaimStatus
|
||||
- invalidClaimRevision
|
||||
- invalidPartyStatus
|
||||
- invalidRequest
|
||||
- invalidDeadline
|
||||
message:
|
||||
description: Человекочитаемое описание ошибки
|
||||
type: string
|
||||
example: Invalid claim status
|
@ -125,20 +125,6 @@ parameters:
|
||||
type: string
|
||||
maxLength: 32
|
||||
minLength: 1
|
||||
claimID:
|
||||
name: claimID
|
||||
in: path
|
||||
description: Идентификатор заявки
|
||||
required: true
|
||||
type: integer
|
||||
format: int64
|
||||
claimRevision:
|
||||
name: claimRevision
|
||||
in: query
|
||||
description: Версия заявки
|
||||
required: true
|
||||
type: integer
|
||||
format: int32
|
||||
shopID:
|
||||
name: shopID
|
||||
in: path
|
||||
@ -358,18 +344,6 @@ tags:
|
||||
description: >
|
||||
Участник системы - совокупность данных о вашей организации, составе и условиях
|
||||
заключенных договоров, а также информация о связанных с организацией магазинах.
|
||||
- name: Claims
|
||||
x-displayName: Заявки
|
||||
description: >
|
||||
Некоторая область данных может быть изменена только после премодерации на
|
||||
стороне платформы. Например, создание и активация новых магазинов,
|
||||
изменение финансовых данных вашего участника и т.п. требуют ручной
|
||||
проверки сотрудниками RBKmoney. Попытка изменить такие данные приводит к
|
||||
автоматическому созданию заявки на изменение данных. До тех пор, пока
|
||||
заявка не одобрена, вы можете добавлять изменения. После одобрения они
|
||||
будут применены к набору данных. В случае отказа по заявке данные
|
||||
останутся в неизменном состоянии. Ближайшим аналогом заявок можно
|
||||
представить Pull Request в распределенных системах контроля версий.
|
||||
- name: Shops
|
||||
x-displayName: Магазины
|
||||
description: >
|
||||
@ -741,8 +715,6 @@ tags:
|
||||
| **inconsistentRefundCurrency** | Попытка возврата средств в валюте, отличной от валюты платежа. |
|
||||
| **changesetConflict** | Попытка внести изменения участника, конфликтующие с изменениями в других заявках, ожидающих рассмотрения. |
|
||||
| **invalidChangeset** | Неверные изменения участника, например, попытка создать магазин в валюте, недоступной в рамках договора. |
|
||||
| **invalidClaimStatus** | Неверный статус заявки. Например, при попытке [отзыва](#operation/revokeClaimByID) уже принятой заявки. |
|
||||
| **invalidClaimRevision** | Неверная ревизия заявки. Например, в случае если заявку одновременно с вами кто-то уже принял или отклонил. |
|
||||
| **limitExceeded** | Превышен разумный лимит выборки. В этом случае лучше запросить менее объёмный набор данных. |
|
||||
| **invalidDeadline** | Неверный формат времени. |
|
||||
| **chargebackInProgress** | Попытка возврата при открытом возвратном платеже. |
|
||||
|
Loading…
Reference in New Issue
Block a user