dispatch/OPENAPI_DOC.yml at master · PlaceOS/dispatch · GitHub

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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
---
openapi: 3.0.3
info:
  description: PlaceOS Dispatch Service. Routes incoming protocol data to drivers
    that have registered their interest
  title: dispatch
  version: 1.6.0
paths:
  /api/dispatch/v1:
    get:
      summary: Returns details about open servers and number of engine drivers listening.
      description: 'Returns details about open servers and number of engine drivers
        listening.

        Also returns details about the number of TCP client connections to the servers'
      tags:
      - Dispatcher
      operationId: Dispatcher_index
      parameters: []
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dispatcher__Stats'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__CommonError'
        406:
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        422:
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
  /api/dispatch/v1/healthz:
    get:
      summary: used to check service is responding
      tags:
      - Dispatcher
      operationId: Dispatcher_healthcheck
      parameters: []
      responses:
        200:
          description: OK
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__CommonError'
        406:
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        422:
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
  /api/dispatch/v1/version:
    get:
      summary: returns the service commit level and build time
      tags:
      - Dispatcher
      operationId: Dispatcher_version
      parameters: []
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlaceOS__Model__Version'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__CommonError'
        406:
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        422:
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
  /api/dispatch/v1/tcp_dispatch:
    get:
      summary: Registers interest in TCP connections being opened on a certain port
      tags:
      - Dispatcher
      operationId: Dispatcher_tcp_dispatch
      parameters:
      - name: port
        in: query
        description: the port we expect the client to connect to
        example: "5001"
        required: true
        schema:
          type: integer
          format: UInt32
      - name: accept
        in: query
        description: a list of ip addresses we expect to connect
        example: 192.168.0.2,10.0.0.50
        required: true
        schema:
          type: string
      responses:
        101:
          description: Switching Protocols
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__CommonError'
        406:
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        422:
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
  /api/dispatch/v1/tls_dispatch:
    get:
      summary: Registers interest in TLS connections being opened on a certain port.
      description: 'Registers interest in TLS connections being opened on a certain
        port.

        Uses the same websocket protocol as `tcp_dispatch`, data is sent and received
        decrypted'
      tags:
      - Dispatcher
      operationId: Dispatcher_tls_dispatch
      parameters:
      - name: port
        in: query
        description: the port we expect the client to connect to
        example: "5001"
        required: true
        schema:
          type: integer
          format: UInt32
      - name: accept
        in: query
        description: a list of ip addresses we expect to connect
        example: 192.168.0.2,10.0.0.50
        required: true
        schema:
          type: string
      - name: certificate
        in: query
        description: PEM encoded certificate (optionally including the chain). A self-signed
          certificate is generated if not provided
        schema:
          type: string
          nullable: true
      - name: private_key
        in: query
        description: PEM encoded private key. Required if a certificate is provided,
          a key is generated if neither are provided
        schema:
          type: string
          nullable: true
      responses:
        101:
          description: Switching Protocols
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__CommonError'
        406:
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        422:
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
  /api/dispatch/v1/udp_dispatch:
    get:
      summary: registers interest of incoming UDP data
      tags:
      - Dispatcher
      operationId: Dispatcher_udp_dispatch
      parameters:
      - name: port
        in: query
        description: the port we expect the client to connect to
        example: "5001"
        required: true
        schema:
          type: integer
          format: UInt32
      - name: accept
        in: query
        description: a list of ip addresses we expect to connect
        example: 192.168.0.2,10.0.0.50
        required: true
        schema:
          type: string
      responses:
        101:
          description: Switching Protocols
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__CommonError'
        406:
          description: Not Acceptable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        415:
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ContentError'
        422:
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application__ParameterError'
components:
  schemas:
    Dispatcher__Stats:
      type: object
      properties:
        udp_listeners:
          type: object
          additionalProperties:
            type: integer
            format: Int32
        tcp_listeners:
          type: object
          additionalProperties:
            type: integer
            format: Int32
        tcp_clients:
          type: object
          additionalProperties:
            type: integer
            format: Int32
      required:
      - udp_listeners
      - tcp_listeners
      - tcp_clients
    PlaceOS__Model__Version:
      type: object
      properties:
        service:
          type: string
        commit:
          type: string
        version:
          type: string
        build_time:
          type: string
        platform_version:
          type: string
      required:
      - service
      - commit
      - version
      - build_time
      - platform_version
    Application__CommonError:
      type: object
      properties:
        error:
          type: string
          nullable: true
        backtrace:
          type: array
          items:
            type: string
          nullable: true
      required: []
    Application__ContentError:
      type: object
      properties:
        error:
          type: string
        accepts:
          type: array
          items:
            type: string
          nullable: true
      required:
      - error
      description: Provides details on available data formats
    Application__ParameterError:
      type: object
      properties:
        error:
          type: string
        parameter:
          type: string
          nullable: true
        restriction:
          type: string
          nullable: true
      required:
      - error
      description: Provides details on which parameter is missing or invalid