Merge pull request #30 from rarimo/feature/deprecate_light_flow

Added a deprecation notice to the light verification flow endpoints

Author: ihordiachenko

docs/spec/README.md

@@ -23,3 +23,8 @@ paths:
               $ref: "#/headers/Rate-Limit-Limit"
 ```
 
+## Deprecation Notice
+
+**The light verification flow is deprecated and will be removed in a future version.**
+All endpoints under the path `/integrations/verificator-svc/light/` are affected by this deprecation.
+Please use the full verification flow instead.

docs/spec/paths/integrations@verificator-svc@light@private@user@{user_id}.yaml

@@ -1,9 +1,12 @@
 delete:
   tags:
-    - Light User verification
+    - Light User verification[DEPRECATED]
   summary: Delete user
   description: |
+    DEPRECATED: The light verification flow is deprecated and will be removed in a future version. Please use the full verification flow instead.
+
     Delete user by UserID.
+  deprecated: true
   operationId: deleteUser
   parameters:
     - $ref: '#/components/parameters/pathID'
@@ -18,10 +21,13 @@ delete:
       $ref: '#/components/responses/internalError'
 get:
   tags:
-    - Light User verification
+    - Light User verification[DEPRECATED]
   summary: Get user
   description: |
+    DEPRECATED: The light verification flow is deprecated and will be removed in a future version. Please use the full verification flow instead.
+
     Get information about user by UserID
+  deprecated: true
   operationId: getUser
   parameters:
     - $ref: '#/components/parameters/pathID'

docs/spec/paths/integrations@verificator-svc@light@private@verification-link.yaml

@@ -1,9 +1,12 @@
 post:
   tags:
-    - Light User verification
+    - Light User verification[DEPRECATED]
   summary: Request verification links for qr-code generation
   description: |
+    DEPRECATED: The light verification flow is deprecated and will be removed in a future version. Please use the full verification flow instead.
+
     Requests verification links for user to generate qr-code, returns: get_proof_params.
+  deprecated: true
   operationId: getVerificationLink
   requestBody:
     required: true

docs/spec/paths/integrations@verificator-svc@light@private@verification-status@{user_id}.yaml

@@ -1,9 +1,12 @@
 get:
   tags:
-    - Light User verification
+    - Light User verification[DEPRECATED]
   summary: Get user verification status
   description: |
+    DEPRECATED: The light verification flow is deprecated and will be removed in a future version. Please use the full verification flow instead.
+
     Get user verification status by UserID.
+  deprecated: true
   operationId: getUserStatus
   parameters:
     - $ref: '#/components/parameters/pathID'

docs/spec/paths/integrations@verificator-svc@light@public@callback-sign@{user_id_hash}.yaml

@@ -1,9 +1,12 @@
 post:
   tags:
-    - Light Signature
+    - Light Signature[DEPRECATED]
   summary: Receive signature and message by callback(mobile)
   description: >-
+    DEPRECATED: The light verification flow is deprecated and will be removed in a future version. Please use the full verification flow instead.
+
     It receives the signature and message for verification by callback url
+  deprecated: true
   operationId: receiveSignatureByCallback
   parameters:
     - $ref: '#/components/parameters/pathIDHash'

docs/spec/paths/integrations@verificator-svc@light@public@proof-params@{user_id_hash}.yaml

@@ -1,9 +1,12 @@
 get:
   tags:
-    - Light Signature
+    - Light Signature[DEPRECATED]
   summary: Get Proof Parameters(mobile)
   description: |
+    DEPRECATED: The light verification flow is deprecated and will be removed in a future version. Please use the full verification flow instead.
+
     Get proof parameters by userIDHash, returns: proof-params and callback_url.
+  deprecated: true
   operationId: getProofParameters
   parameters:
     - $ref: '#/components/parameters/pathIDHash'