JSON Schema Update

Author: nobody

config/v3/exchange_verification_code/example.json

@@ -0,0 +1,5 @@
+{
+    "exchange_verification_code": "1",
+    "type": "account_opening",
+    "verification_code": "abCD0123"
+}

config/v3/exchange_verification_code/receive.json

@@ -0,0 +1,42 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Exchange Verification Code (response)",
+    "description": "Exchange Verification Code Response",
+    "type": "object",
+    "required": [
+        "echo_req",
+        "msg_type"
+    ],
+    "properties": {
+        "exchange_verification_code": {
+            "title": "exchange_verification_code",
+            "description": "Exchange Verification Code details",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "new_verification_code"
+            ],
+            "properties": {
+                "new_verification_code": {
+                    "description": "The new code generated after successful verification",
+                    "type": "string"
+                }
+            }
+        },
+        "echo_req": {
+            "description": "Echo of the request made.",
+            "type": "object"
+        },
+        "msg_type": {
+            "description": "Action name of the request made.",
+            "type": "string",
+            "enum": [
+                "exchange_verification_code"
+            ]
+        },
+        "req_id": {
+            "description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
+            "type": "integer"
+        }
+    }
+}

config/v3/exchange_verification_code/send.json

@@ -0,0 +1,43 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "Exchange Verification Code (request)",
+    "description": "Verifies the code and returns a new code if verification is successful",
+    "type": "object",
+    "auth_required": 0,
+    "additionalProperties": false,
+    "required": [
+        "exchange_verification_code",
+        "verification_code"
+    ],
+    "properties": {
+        "exchange_verification_code": {
+            "description": "Must be `1`",
+            "type": "integer",
+            "enum": [
+                1
+            ]
+        },
+        "type": {
+            "description": "[Optional] Purpose of the token exchange.",
+            "type": "string",
+            "default": "account_opening",
+            "enum": [
+                "account_opening"
+            ]
+        },
+        "verification_code": {
+            "description": "Email verification code (received from a `verify_email` call which must be done first).",
+            "type": "string",
+            "pattern": "^\\w{8,128}$",
+            "sensitive": 1
+        },
+        "passthrough": {
+            "description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.",
+            "type": "object"
+        },
+        "req_id": {
+            "description": "[Optional] Used to map request to response.",
+            "type": "integer"
+        }
+    }
+}

static/data/v3.yml

@@ -63,6 +63,8 @@ groups:
         title: Economic Calendar
       - name: exchange_rates
         title: Exchange Rates
+      - name: exchange_verification_code
+        title: Exchange Verification Code
       - name: financial_assessment_questions
         title: Financial Assessment Questions
       - name: forget