-
Notifications
You must be signed in to change notification settings - Fork 13
Expand file tree
/
Copy pathswagger.yaml
More file actions
395 lines (395 loc) · 9.89 KB
/
Copy pathswagger.yaml
File metadata and controls
395 lines (395 loc) · 9.89 KB
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
---
openapi: 3.0.0
info:
version: '1.0'
title: Data Exchange API
description: To invoke the API programmatically, include the API key as Bearer token in the authorization header.
servers:
- url: /api/v1
paths:
/id:
get:
tags:
- ID
description: Peer information
responses:
'200':
description: Peer information
content:
application/json:
schema:
$ref: '#/components/schemas/PeerInformation'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/status:
get:
tags:
- Status
description: Status
responses:
'200':
description: Status
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/peers:
get:
tags:
- Peers
description: List peers
responses:
'200':
description: Peers
content:
application/json:
schema:
$ref: '#/components/schemas/Peers'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/peers/{id}:
parameters:
- in: path
name: id
required: true
schema:
type: string
description: Peer id
put:
tags:
- Peers
description: Add peer
responses:
'200':
description: Peer added
content:
application/json:
schema:
$ref: '#/components/schemas/Added'
'400':
description: Missing peer endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
tags:
- Peers
description: Remove peer
responses:
'200':
description: Peer removed
content:
application/json:
schema:
$ref: '#/components/schemas/Removed'
'404':
description: Peer not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/messages:
post:
tags:
- Messages
description: Send message
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Message'
responses:
'200':
description: Message submitted
content:
application/json:
schema:
$ref: '#/components/schemas/Submitted'
'400':
description: Invalid message or recipient
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/blobs/{blobPath}:
parameters:
- in: path
name: blobPath
required: true
schema:
type: string
description: Blob path
head:
tags:
- Blobs
description: Retrieve blob metadata
responses:
'204':
description: Blob metadata
headers:
dx-hash:
schema:
type: string
description: Blob hash
dx-last-update:
schema:
type: string
description: Blob last update timestamp
'404':
description: Blob not found
'500':
description: Internal error
get:
tags:
- Blobs
description: Retreive blob
responses:
'200':
description: Blob content
headers:
dx-hash:
schema:
type: string
description: Blob hash
dx-last-update:
schema:
type: string
description: Blob last update timestamp
content:
application/json:
schema:
type: string
format: binary
'404':
description: Blob not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
tags:
- Blobs
description: Store blob
requestBody:
description: Blob
required: true
content:
multipart/form-data:
schema:
type: object
properties:
fileName:
type: string
format: binary
responses:
'200':
description: Blob hash
content:
application/json:
schema:
$ref: '#/components/schemas/BlobHash'
'400':
description: Missing blob
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/transfers:
post:
tags:
- Transfers
description: Transfer blob
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Transfer'
responses:
'200':
description: Transfer submitted
content:
application/json:
schema:
$ref: '#/components/schemas/Submitted'
'400':
description: Invalid path or recipient
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Blob not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
schemas:
PeerInformation:
type: object
required:
- id
- endpoint
- cert
properties:
id:
type: string
endpoint:
type: string
cert:
type: string
Status:
type: object
required:
- messageQueueSize
- peers
properties:
messageQueueSize:
type: integer
peers:
type: array
items:
type: object
required:
- id
- available
properties:
id:
type: string
available:
type: boolean
Peer:
type: object
required:
- id
- endpoint
properties:
id:
type: string
endpoint:
type: string
Peers:
type: array
items:
$ref: '#/components/schemas/Peer'
Added:
type: object
required:
- status
properties:
status:
type: string
enum: ['added']
Removed:
type: object
required:
- status
properties:
status:
type: string
enum: ['removed']
Message:
type: object
required:
- message
- recipient
properties:
message:
type: string
recipient:
type: string
requestId:
type: string
BlobHash:
type: object
required:
- hash
properties:
hash:
type: string
Transfer:
type: object
required:
- path
- recipient
properties:
path:
type: string
recipient:
type: string
requestId:
type: string
Submitted:
type: object
required:
- requestId
properties:
requestId:
type: string
Error:
type: object
required:
- error
properties:
error:
type: string
security:
- ApiKeyAuth: []