-
Notifications
You must be signed in to change notification settings - Fork 3
/
schema.json
174 lines (170 loc) · 4.68 KB
/
schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
{
"openapi": "3.1.0",
"info": {
"title": "Sea of Bottles API",
"description": "Send a bottle with a letter to sea, and get a reply from other people, or reply a bottle from other people, you can get your unread letters here",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://bottle.immersivetranslate.com"
}
],
"paths": {
"/api/send-bottle-with-letter": {
"get": {
"description": "Send bottle with a letter to sea, you must ask the user for the letter they want to carry in the bottle before requesting this API, once succeed, you can remind user that they can check their unread message manually.",
"operationId": "sendBottleWithLetter",
"parameters": [
{
"name": "letter",
"in": "query",
"description": "letter content",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "targetGender",
"in": "query",
"description": "target gender of the bottle, male or female, optional",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "targetMinAge",
"in": "query",
"description": "target min age of the bottle, optional",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "targetMaxAge",
"in": "query",
"description": "target max age of the bottle, optional",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "targetIsoCountryCode",
"in": "query",
"description": "target iso country code of the bottle, optional",
"required": false,
"schema": {
"type": "string"
}
}
],
"deprecated": false
}
},
"/api/get-bottles": {
"get": {
"description": "Get ran bottles from sea, if user specify the filter, then the result will be filtered",
"operationId": "getBottles",
"parameters": [
{
"name": "filterGender",
"in": "query",
"description": "filter bottles with specific gender, male or female, optional",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filterMinAge",
"in": "query",
"description": "filter bottles with specific min age, optional",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filterMaxAge",
"in": "query",
"description": "filter bottles with specific max age, optional",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "filterIsoCountryCode",
"in": "query",
"description": "filter bottles with specific iso country code, optional",
"required": false,
"schema": {
"type": "string"
}
}
],
"deprecated": false
}
},
"/api/release-bottle": {
"get": {
"description": "Release a bottle from sea",
"operationId": "releaseBottle",
"parameters": [
{
"name": "bottleId",
"in": "query",
"description": "id of the bottle",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false
}
},
"/api/reply-bottle": {
"get": {
"description": "reply a bottle",
"operationId": "replyBottleWithLetter",
"parameters": [
{
"name": "bottleId",
"in": "query",
"description": "id of the bottle",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "letter",
"in": "query",
"description": "letter content",
"required": true,
"schema": {
"type": "string"
}
}
],
"deprecated": false
}
},
"/api/get-unread-letters": {
"get": {
"description": "Get all unread letters",
"operationId": "getUnreadLetters",
"parameters": [],
"deprecated": false
}
}
},
"components": {
"schemas": {}
}
}