From f1c178db1aaf55abe0018858be1c7c056bde7aaa Mon Sep 17 00:00:00 2001 From: Boris Date: Thu, 18 Nov 2021 19:59:52 +0300 Subject: [PATCH] [ED-318] delete Identification's step for wallet Identity (#100) --- CHANGELOG.md | 19 ++++++ api/wallet/spec/definitions/Identity.yaml | 15 ----- .../spec/definitions/IdentityChallenge.yaml | 38 ----------- .../definitions/IdentityChallengeEvent.yaml | 21 ------ .../IdentityChallengeEventChange.yaml | 12 ---- .../spec/definitions/IdentityChallengeID.yaml | 3 - .../definitions/IdentityChallengeStatus.yaml | 25 ------- .../IdentityChallengeStatusChanged.yaml | 4 -- .../IdentityChallengeStatusValue.yaml | 16 ----- .../definitions/IdentityChallengeType.yaml | 21 ------ .../definitions/IdentityChallengeTypeID.yaml | 3 - .../spec/definitions/IdentityClass.yaml | 10 --- .../spec/definitions/IdentityClassID.yaml | 3 - .../spec/definitions/IdentityLevel.yaml | 17 ----- .../spec/definitions/IdentityLevelID.yaml | 3 - api/wallet/spec/paths/identities.yaml | 15 ----- .../identities@{identityID}@challenges.yaml | 66 ------------------- ...{identityID}@challenges@{challengeID}.yaml | 21 ------ ...tyID}@challenges@{challengeID}@events.yaml | 25 ------- ...lenges@{challengeID}@events@{eventID}.yaml | 22 ------- ...oviders@{providerID}@identity-classes.yaml | 22 ------- ...D}@identity-classes@{identityClassID}.yaml | 25 ------- ...tity-classes@{identityClassID}@levels.yaml | 27 -------- ...tityClassID}@levels@{identityLevelID}.yaml | 30 --------- 24 files changed, 19 insertions(+), 444 deletions(-) delete mode 100644 api/wallet/spec/definitions/IdentityChallenge.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeEvent.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeEventChange.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeID.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeStatus.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeStatusChanged.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeStatusValue.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeType.yaml delete mode 100644 api/wallet/spec/definitions/IdentityChallengeTypeID.yaml delete mode 100644 api/wallet/spec/definitions/IdentityClass.yaml delete mode 100644 api/wallet/spec/definitions/IdentityClassID.yaml delete mode 100644 api/wallet/spec/definitions/IdentityLevel.yaml delete mode 100644 api/wallet/spec/definitions/IdentityLevelID.yaml delete mode 100644 api/wallet/spec/paths/identities@{identityID}@challenges.yaml delete mode 100644 api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}.yaml delete mode 100644 api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events.yaml delete mode 100644 api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events@{eventID}.yaml delete mode 100644 api/wallet/spec/paths/providers@{providerID}@identity-classes.yaml delete mode 100644 api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}.yaml delete mode 100644 api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels.yaml delete mode 100644 api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels@{identityLevelID}.yaml diff --git a/CHANGELOG.md b/CHANGELOG.md index 210fa36..3dab4aa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,24 @@ # Swag-wallets changelog +## Version 0.0.3 to 0.0.4 - 16.11.2021 +--- +### What's Deprecated(not supported yet) +--- +Удалена процедура идентификации владельца кошелька. + +`GET` /identities/{identityID}/challenges +`POST` /identities/{identityID}/challenges +`GET` /identities/{identityID}/challenges/{challengeID} +`GET` /identities/{identityID}/challenges/{challengeID}/events +`GET` /identities/{identityID}/challenges/{challengeID}/events/{eventID} + +Удалена информация о классе владельца и уровне идентификации + +`GET` /providers/{providerID}/identity-classes +`GET` /providers/{providerID}/identity-classes/{identityClassID} +`GET` /providers/{providerID}/identity-classes/{identityClassID}/levels +`GET` /providers/{providerID}/identity-classes/{identityClassID}/levels/{identityLevelID} + ## Version 0.0.2 to 0.0.3 - 22.09.2021 --- ### What's Deprecated(not supported yet) diff --git a/api/wallet/spec/definitions/Identity.yaml b/api/wallet/spec/definitions/Identity.yaml index c0ed411..29ab10a 100644 --- a/api/wallet/spec/definitions/Identity.yaml +++ b/api/wallet/spec/definitions/Identity.yaml @@ -3,7 +3,6 @@ type: object required: - name - provider - - class properties: id: x-rebillyMerge: @@ -22,20 +21,6 @@ properties: provider: x-rebillyMerge: - $ref: '#/definitions/ProviderID' - class: - x-rebillyMerge: - - $ref: '#/definitions/IdentityClassID' - level: - x-rebillyMerge: - - $ref: '#/definitions/IdentityLevelID' - - readOnly: true - effectiveChallenge: - x-rebillyMerge: - - $ref: '#/definitions/IdentityChallengeID' - - description: | - Идентификатор успешно пройденной процедура идентификации, результат которой действителен на - текущий момент - readOnly: true isBlocked: description: Заблокирована ли личность владельца? type: boolean diff --git a/api/wallet/spec/definitions/IdentityChallenge.yaml b/api/wallet/spec/definitions/IdentityChallenge.yaml deleted file mode 100644 index d887ab5..0000000 --- a/api/wallet/spec/definitions/IdentityChallenge.yaml +++ /dev/null @@ -1,38 +0,0 @@ -description: Процедура идентификации личности -allOf: - - type: object - required: - - type - - proofs - properties: - id: - x-rebillyMerge: - - $ref: '#/definitions/IdentityChallengeID' - - readOnly: true - createdAt: - description: Дата и время запуска процедуры - type: string - format: date-time - readOnly: true - type: - x-rebillyMerge: - - $ref: '#/definitions/IdentityChallengeTypeID' - proofs: - description: | - Набор представленных доказательств. - - См. [RBKmoney Private Documents API](?api/privdoc/swagger.json). - type: array - uniqueItems: true - items: - $ref: '#/definitions/SecuredPrivateDocument' - # example: - # - type: RUSDomesticPassport - # token: 7kodCm5gr68ji4O11KpVn0 - # seriesMasked: "4***" - # numberMasked: "*****6" - # fullnameMasked: "И***** И.И." - # - type: RUSRetireeInsuranceCertificate - # token: Gfu6tLdqS2qtxsdB6WjOQ5h - # numberMasked: "12-**** ***0" - - $ref: '#/definitions/IdentityChallengeStatus' diff --git a/api/wallet/spec/definitions/IdentityChallengeEvent.yaml b/api/wallet/spec/definitions/IdentityChallengeEvent.yaml deleted file mode 100644 index f64bc6e..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeEvent.yaml +++ /dev/null @@ -1,21 +0,0 @@ -description: | - Событие, возникшее в процессе процедуры идентификации -type: object -required: - - eventID - - occuredAt - - changes -properties: - eventID: - description: Идентификатор события процедуры идентификации - type: integer - format: int32 - example: 42 - occuredAt: - description: Дата и время возникновения события - type: string - format: date-time - changes: - type: array - items: - $ref: '#/definitions/IdentityChallengeEventChange' diff --git a/api/wallet/spec/definitions/IdentityChallengeEventChange.yaml b/api/wallet/spec/definitions/IdentityChallengeEventChange.yaml deleted file mode 100644 index 6acf1ad..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeEventChange.yaml +++ /dev/null @@ -1,12 +0,0 @@ -description: | - Изменение, возникшее в процессе процедуры идентификации -type: object -discriminator: type -required: - - type -properties: - type: - description: Тип произошедшего изменения - type: string - enum: - - IdentityChallengeStatusChanged diff --git a/api/wallet/spec/definitions/IdentityChallengeID.yaml b/api/wallet/spec/definitions/IdentityChallengeID.yaml deleted file mode 100644 index bee5d98..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeID.yaml +++ /dev/null @@ -1,3 +0,0 @@ -description: Идентификатор процедуры идентификации личности -type: string -example: "1" diff --git a/api/wallet/spec/definitions/IdentityChallengeStatus.yaml b/api/wallet/spec/definitions/IdentityChallengeStatus.yaml deleted file mode 100644 index 2468c16..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeStatus.yaml +++ /dev/null @@ -1,25 +0,0 @@ -type: object -properties: - status: - x-rebillyMerge: - - $ref: '#/definitions/IdentityChallengeStatusValue' - - readOnly: true - validUntil: - # TODO - # Интересно, помогла бы механика из OpenAPI 3.x, которая позволила бы задачть discriminator по `status`, - # а потом allOf'нуть его в основной объект `IdentityChallenge`? - description: | - > Если `status` == `Completed` - - Дата и время, до наступления которых результат процедуры действителен - type: string - format: date-time - readOnly: true - failureReason: - description: | - > Если `status` == `Failed` - - Описание причины неудачного завершения процедуры - type: string - example: Proof incomplete - readOnly: true diff --git a/api/wallet/spec/definitions/IdentityChallengeStatusChanged.yaml b/api/wallet/spec/definitions/IdentityChallengeStatusChanged.yaml deleted file mode 100644 index 7a05563..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeStatusChanged.yaml +++ /dev/null @@ -1,4 +0,0 @@ -description: Изменение статуса процедуры идентификации -allOf: - - $ref: '#/definitions/IdentityChallengeEventChange' - - $ref: '#/definitions/IdentityChallengeStatus' diff --git a/api/wallet/spec/definitions/IdentityChallengeStatusValue.yaml b/api/wallet/spec/definitions/IdentityChallengeStatusValue.yaml deleted file mode 100644 index fe59ada..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeStatusValue.yaml +++ /dev/null @@ -1,16 +0,0 @@ -description: | - Статус процедуры идентификации личности. - - | Значение | Пояснение | - | ----------- | ------------------------------- | - | `Pending` | Процедура в процессе выполнения | - | `Completed` | Процедура пройдена успешно | - | `Failed` | Процедура не пройдена | - | `Cancelled` | Процедура отменена | - -type: string -enum: - - Pending - - Completed - - Failed - - Cancelled diff --git a/api/wallet/spec/definitions/IdentityChallengeType.yaml b/api/wallet/spec/definitions/IdentityChallengeType.yaml deleted file mode 100644 index b5a38e9..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeType.yaml +++ /dev/null @@ -1,21 +0,0 @@ -description: Описание типа процедуры идентификации личности -type: object -properties: - id: - x-rebillyMerge: - - $ref: '#/definitions/IdentityChallengeTypeID' - name: - description: | - Человекочитаемое название процедуры идентификации - type: string - example: Упрощённая идентификация - requiredProofs: - description: | - Набор доказательств, которые необходимо предоставить - type: array - items: - x-rebillyMerge: - - $ref: '#/definitions/SecuredPrivateDocumentType' - example: - - RUSDomesticPassport - - RUSRetireeInsuranceCertificate diff --git a/api/wallet/spec/definitions/IdentityChallengeTypeID.yaml b/api/wallet/spec/definitions/IdentityChallengeTypeID.yaml deleted file mode 100644 index 998bd25..0000000 --- a/api/wallet/spec/definitions/IdentityChallengeTypeID.yaml +++ /dev/null @@ -1,3 +0,0 @@ -description: Тип процедуры идентификации личности -type: string -example: esia diff --git a/api/wallet/spec/definitions/IdentityClass.yaml b/api/wallet/spec/definitions/IdentityClass.yaml deleted file mode 100644 index 0bc1c80..0000000 --- a/api/wallet/spec/definitions/IdentityClass.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -properties: - id: - x-rebillyMerge: - - $ref: '#/definitions/IdentityClassID' - name: - description: | - Человекочитаемое название класса - type: string - example: Частное лицо diff --git a/api/wallet/spec/definitions/IdentityClassID.yaml b/api/wallet/spec/definitions/IdentityClassID.yaml deleted file mode 100644 index fff8c2d..0000000 --- a/api/wallet/spec/definitions/IdentityClassID.yaml +++ /dev/null @@ -1,3 +0,0 @@ -description: Класс личности владельцев -type: string -example: person diff --git a/api/wallet/spec/definitions/IdentityLevel.yaml b/api/wallet/spec/definitions/IdentityLevel.yaml deleted file mode 100644 index 85ebbba..0000000 --- a/api/wallet/spec/definitions/IdentityLevel.yaml +++ /dev/null @@ -1,17 +0,0 @@ -type: object -properties: - id: - x-rebillyMerge: - - $ref: '#/definitions/IdentityLevelID' - name: - description: | - Человекочитаемое название уровня идентификации - type: string - example: Частично идентифицирован - challenges: - description: | - Список возможных процедур, которые необходимо пройти для достижения этого - уровня - type: array - items: - $ref: '#/definitions/IdentityChallengeType' diff --git a/api/wallet/spec/definitions/IdentityLevelID.yaml b/api/wallet/spec/definitions/IdentityLevelID.yaml deleted file mode 100644 index 5d9e321..0000000 --- a/api/wallet/spec/definitions/IdentityLevelID.yaml +++ /dev/null @@ -1,3 +0,0 @@ -description: Уровень идентификации личности -type: string -example: partial diff --git a/api/wallet/spec/paths/identities.yaml b/api/wallet/spec/paths/identities.yaml index ad911fe..ad15f66 100644 --- a/api/wallet/spec/paths/identities.yaml +++ b/api/wallet/spec/paths/identities.yaml @@ -13,21 +13,6 @@ get: type: string maxLength: 40 minLength: 1 - - name: class - description: Класс личности - in: query - required: false - type: string - maxLength: 40 - minLength: 1 - - name: level - description: Уровень идентификации - in: query - required: false - type: string - maxLength: 40 - minLength: 1 - - $ref: '#/parameters/limit' - x-rebillyMerge: - name: continuationToken in: query diff --git a/api/wallet/spec/paths/identities@{identityID}@challenges.yaml b/api/wallet/spec/paths/identities@{identityID}@challenges.yaml deleted file mode 100644 index b3554a5..0000000 --- a/api/wallet/spec/paths/identities@{identityID}@challenges.yaml +++ /dev/null @@ -1,66 +0,0 @@ -get: - operationId: listIdentityChallenges - summary: Перечислить процедуры идентификации - tags: - - Identities - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - x-rebillyMerge: - - name: status - description: Фильтр по статусу процедуры - in: query - required: false - - $ref: '#/definitions/IdentityChallengeStatusValue' - responses: - '200': - description: Процедуры идентификации найдены - schema: - type: array - items: - $ref: '#/definitions/IdentityChallenge' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' - -post: - operationId: startIdentityChallenge - summary: Запустить процедуру идентификации - tags: - - Identities - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - name: challenge - description: Данные для запуска процедуры идентификации - in: body - required: true - schema: - $ref: '#/definitions/IdentityChallenge' - responses: - '202': - description: Процедура идентификации запущена - headers: - Location: - description: URI запущенной процедуры - type: string - format: uri - schema: - $ref: '#/definitions/IdentityChallenge' - '422': - description: Неверные данные для проведения процедуры - schema: - $ref: '#/definitions/InvalidOperationParameters' - '409': - description: Ранее запущенная процедура ещё не завершена - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}.yaml b/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}.yaml deleted file mode 100644 index 4db553d..0000000 --- a/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}.yaml +++ /dev/null @@ -1,21 +0,0 @@ -get: - operationId: getIdentityChallenge - summary: Получить данные процедуры идентификации - tags: - - Identities - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - $ref: '#/parameters/challengeID' - responses: - '200': - description: Процедура идентификации найдена - schema: - $ref: '#/definitions/IdentityChallenge' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events.yaml b/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events.yaml deleted file mode 100644 index 000ede0..0000000 --- a/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events.yaml +++ /dev/null @@ -1,25 +0,0 @@ -get: - operationId: pollIdentityChallengeEvents - summary: Запросить события процедуры идентификации - tags: - - Identities - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - $ref: '#/parameters/challengeID' - - $ref: '#/parameters/limit' - - $ref: '#/parameters/eventCursor' - responses: - '200': - description: События найдены - schema: - type: array - items: - $ref: '#/definitions/IdentityChallengeEvent' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events@{eventID}.yaml b/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events@{eventID}.yaml deleted file mode 100644 index 0fd4cd5..0000000 --- a/api/wallet/spec/paths/identities@{identityID}@challenges@{challengeID}@events@{eventID}.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - operationId: getIdentityChallengeEvent - summary: Получить событие процедуры идентификации - tags: - - Identities - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/identityID' - - $ref: '#/parameters/challengeID' - - $ref: '#/parameters/eventID' - responses: - '200': - description: Событие найдено - schema: - $ref: '#/definitions/IdentityChallengeEvent' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/providers@{providerID}@identity-classes.yaml b/api/wallet/spec/paths/providers@{providerID}@identity-classes.yaml deleted file mode 100644 index ba304bb..0000000 --- a/api/wallet/spec/paths/providers@{providerID}@identity-classes.yaml +++ /dev/null @@ -1,22 +0,0 @@ -get: - operationId: listProviderIdentityClasses - summary: Перечислить классы личностей - tags: - - Providers - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/providerID' - responses: - '200': - description: Классы личностей найдены - schema: - type: array - items: - $ref: '#/definitions/IdentityClass' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}.yaml b/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}.yaml deleted file mode 100644 index 070cc79..0000000 --- a/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}.yaml +++ /dev/null @@ -1,25 +0,0 @@ -get: - operationId: getProviderIdentityClass - summary: Получить описание класса личностей - tags: - - Providers - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/providerID' - - name: identityClassID - description: Класс личности владельца - in: path - required: true - type: string - responses: - '200': - description: Класс личностей найден - schema: - $ref: '#/definitions/IdentityClass' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels.yaml b/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels.yaml deleted file mode 100644 index 0387908..0000000 --- a/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels.yaml +++ /dev/null @@ -1,27 +0,0 @@ -get: - operationId: listProviderIdentityLevels - summary: Перечислить уровни идентификации личности - tags: - - Providers - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/providerID' - - name: identityClassID - description: Класс личности владельца - in: path - required: true - type: string - responses: - '200': - description: Уровни идентификации найдены - schema: - type: array - items: - $ref: '#/definitions/IdentityLevel' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized' diff --git a/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels@{identityLevelID}.yaml b/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels@{identityLevelID}.yaml deleted file mode 100644 index 46c0780..0000000 --- a/api/wallet/spec/paths/providers@{providerID}@identity-classes@{identityClassID}@levels@{identityLevelID}.yaml +++ /dev/null @@ -1,30 +0,0 @@ -get: - operationId: getProviderIdentityLevel - summary: Получить описание уровня идентификации - tags: - - Providers - parameters: - - $ref: '#/parameters/requestID' - - $ref: '#/parameters/deadline' - - $ref: '#/parameters/providerID' - - name: identityClassID - description: Класс личности владельца - in: path - required: true - type: string - - name: identityLevelID - description: Уровень идентификации - in: path - required: true - type: string - responses: - '200': - description: Уровень идентификации найден - schema: - $ref: '#/definitions/IdentityLevel' - '404': - $ref: '#/responses/NotFound' - '400': - $ref: '#/responses/BadRequest' - '401': - $ref: '#/responses/Unauthorized'