Skip to content

Commit 638fa31

Browse files
author
Github Workflow
committed
JSON Schema Update
1 parent 43ecc4b commit 638fa31

File tree

7 files changed

+176
-0
lines changed

7 files changed

+176
-0
lines changed

‎config/v3/connect_copy/example.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"connect_copy": 1
3+
}

‎config/v3/connect_copy/receive.json‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-04/schema#",
3+
"title": "V2 Connect Copy (response)",
4+
"description": "The result of copy from v1 user to v2 client",
5+
"type": "object",
6+
"required": [
7+
"echo_req",
8+
"msg_type"
9+
],
10+
"properties": {
11+
"connect_copy": {
12+
"title": "connect_copy",
13+
"description": "Information for the connect_copy",
14+
"type": "object",
15+
"additionalProperties": false,
16+
"properties": {
17+
"status": {
18+
"description": "Status of copy from v1 to v2",
19+
"type": "string",
20+
"enum": [
21+
"pending",
22+
"complete",
23+
"failed"
24+
]
25+
}
26+
}
27+
},
28+
"echo_req": {
29+
"description": "Echo of the request made.",
30+
"type": "object"
31+
},
32+
"msg_type": {
33+
"description": "Action name of the request made.",
34+
"type": "string",
35+
"enum": [
36+
"connect_copy"
37+
]
38+
},
39+
"req_id": {
40+
"description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
41+
"type": "integer"
42+
}
43+
}
44+
}

‎config/v3/connect_copy/send.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-04/schema#",
3+
"title": "V2 Connect Copy (request)",
4+
"description": "Copy user profile from v1 to v2",
5+
"type": "object",
6+
"auth_required": 1,
7+
"auth_scopes": [
8+
"read"
9+
],
10+
"additionalProperties": false,
11+
"required": [
12+
"connect_copy"
13+
],
14+
"properties": {
15+
"connect_copy": {
16+
"description": "Must be `1`",
17+
"type": "integer",
18+
"enum": [
19+
1
20+
]
21+
},
22+
"loginid": {
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
24+
"type": "string",
25+
"pattern": "^[A-Za-z]+[0-9]+$"
26+
},
27+
"passthrough": {
28+
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.",
29+
"type": "object"
30+
},
31+
"req_id": {
32+
"description": "[Optional] Used to map request to response.",
33+
"type": "integer"
34+
}
35+
}
36+
}

‎config/v3/connect_status/example.json‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"connect_status": 1
3+
}

‎config/v3/connect_status/receive.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-04/schema#",
3+
"title": "Connect Status (response)",
4+
"description": "Return the status of V1 client connected to V2",
5+
"type": "object",
6+
"required": [
7+
"echo_req",
8+
"msg_type"
9+
],
10+
"properties": {
11+
"connect_status": {
12+
"title": "connect_status",
13+
"description": "Status of V1 client on V2.",
14+
"type": "object",
15+
"additionalProperties": false,
16+
"required": [
17+
"status"
18+
],
19+
"properties": {
20+
"status": {
21+
"description": "Current status of V1 client on V2.",
22+
"type": [
23+
"null",
24+
"string"
25+
],
26+
"enum": [
27+
"pending",
28+
"complete",
29+
"failed"
30+
]
31+
}
32+
}
33+
},
34+
"echo_req": {
35+
"description": "Echo of the request made.",
36+
"type": "object"
37+
},
38+
"msg_type": {
39+
"description": "Action name of the request made.",
40+
"type": "string",
41+
"enum": [
42+
"connect_status"
43+
]
44+
},
45+
"req_id": {
46+
"description": "Optional field sent in request to map to response, present only when request contains `req_id`.",
47+
"type": "integer"
48+
}
49+
}
50+
}

‎config/v3/connect_status/send.json‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-04/schema#",
3+
"title": "Connect Status (request)",
4+
"description": "Get the status of V1 client connected to V2",
5+
"type": "object",
6+
"auth_required": 1,
7+
"auth_scopes": [
8+
"read"
9+
],
10+
"additionalProperties": false,
11+
"required": [
12+
"connect_status"
13+
],
14+
"properties": {
15+
"connect_status": {
16+
"description": "Must be `1`",
17+
"type": "integer",
18+
"enum": [
19+
1
20+
]
21+
},
22+
"loginid": {
23+
"description": "[Optional] The login id of the user. Mandatory when multiple tokens were provided during authorize.",
24+
"type": "string",
25+
"pattern": "^[A-Za-z]+[0-9]+$"
26+
},
27+
"passthrough": {
28+
"description": "[Optional] Used to pass data through the websocket, which may be retrieved via the `echo_req` output field.",
29+
"type": "object"
30+
},
31+
"req_id": {
32+
"description": "[Optional] Used to map request to response.",
33+
"type": "integer"
34+
}
35+
}
36+
}

‎static/data/v3.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,10 @@ groups:
3737
title: Cashier Information
3838
- name: confirm_email
3939
title: Confirm Email Through Verification Code
40+
- name: connect_copy
41+
title: V2 Connect Copy
42+
- name: connect_status
43+
title: Connect Status
4044
- name: contract_update
4145
title: Update Contract
4246
- name: contract_update_history

0 commit comments

Comments
 (0)