-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
231 lines (224 loc) · 5.96 KB
/
openapi.yaml
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
openapi: 3.0.3
servers: []
info:
description: This is the Gimulator API
version: "0.1.0"
title: Gimulator API
contact:
email: [email protected]
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: admins
description: Secured Admin-only calls
- name: auth
description: Operations related to authentication
- name: game
description: Operations related to the running game
paths:
/register:
post:
tags:
- auth
summary: registers the user
operationId: register
description: Registers a user to the Gimulator and creates a session for it
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- ID
properties:
ID:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
description: User credentials to register
responses:
'200':
description: user registered
headers:
Set-Cookie:
schema:
type: string
example: token=abcde12345; Path=/; HttpOnly
'400':
description: could not decode the body of request
'422':
description: could not authenticate the request
security: []
/get:
post:
tags:
- game
summary: returns an object
operationId: get
description: Returns the value of a specific object by the given key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: Object key to search
responses:
'200':
description: object is found and returned
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
'400':
description: could not decode the body of request
'401':
description: could not auth the request
'422':
description: could not find object by the given key
/set:
post:
tags:
- game
summary: sets an object
operationId: set
description: Sets the value for a specific object by the given key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: Object to set
responses:
'204':
description: object is set
'400':
description: could not decode the body of request
'401':
description: could not auth the request
/find:
post:
tags:
- game
summary: searches and returns objects
operationId: find
description: Returns the objects matching with the given key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: Object key to search
responses:
'200':
description: object is found and returned
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Object'
'400':
description: could not decode the body of request
'401':
description: could not auth the request
/delete:
post:
tags:
- game
summary: deletes an object
operationId: delete
description: Deletes a specific object by the given key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: Object to delete
responses:
'204':
description: object is deleted
'400':
description: could not decode the body of request
'401':
description: could not auth the request
'422':
description: could not find object by the given key
/watch:
post:
tags:
- game
summary: watches on an object
operationId: watch
description: Watches the changes on the value of a specific object by the given key
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Object'
description: Object key to watch
responses:
'204':
description: object is found and added to watches
'400':
description: could not decode the body of request
'401':
description: could not auth the request
/socket:
get:
tags:
- game
summary: opens a websocket
operationId: socket
description: Opens a websocket to server. If any object that is being watched from the client changes, the server will send it to the client through this websocket in a schema of [Object](#Object)
responses:
'101':
description: socket is upgraded
'401':
description: could not auth the request
'500':
description: could not upgrade connection to websocket
components:
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: token
schemas:
Key:
type: object
required:
- Type
- Namespace
- Name
properties:
Type:
type: string
example: action
Namespace:
type: string
example: default
Name:
type: string
example: agent-5
Object:
type: object
required:
- Key
- Value
- Owner
properties:
Key:
$ref: '#/components/schemas/Key'
Value:
type: object
Owner:
type: string
security:
- cookieAuth: []