forked from before-interop/CRI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
474 lines (467 loc) · 13 KB
/
swagger.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
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
openapi: 3.0.0
info:
version: '1.0.0'
title: Get CRI Photos
servers:
- url: '{protocol}://api.interop-fibre.fr/v1'
variables:
protocol:
enum:
- https
default: https
paths:
'/optical-plug/{id}/photos':
get:
tags:
- Get Photo's Metadata
summary: Get Photos metadatas for a given pto (ReferencePrise)
operationId: getPhotosByPto
parameters:
- name: id
in: path
description: Pto identifier
required: true
schema:
type: string
- name: Authorization
in: header
description: >-
Credentials to authenticate an operator, it is a token
with scheme Negotiate.
required: false
schema:
type: string
- name: X-Request-Id
in: header
description: >-
Unique identifier of the request (uuid type recommended).
required: true
schema:
type: string
minLength: 0
maxLength: 36
- name: X-Client-Id
in: header
description: Building Operator Id
required: true
schema:
type: string
responses:
'200':
description: Get Metadata Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Photo'
links:
GetPhotoById:
$ref: '#/components/links/GetPhotoById'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not Authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'/access/{id}/photos':
get:
tags:
- Get Photo's Metadata
summary: Get Photos metadatas for a given access id (RefPrestationPrise)
operationId: getPhotosByAccess
parameters:
- name: id
in: path
description: Pto identifier
required: true
schema:
type: string
- name: Authorization
in: header
description: >-
Credentials to authenticate an operator, it is a token
with scheme Negotiate.
required: false
schema:
type: string
- name: X-Request-Id
in: header
description: >-
Unique identifier of the request (uuid type recommended).
required: true
schema:
type: string
minLength: 0
maxLength: 36
- name: X-Client-Id
in: header
description: Building Operator Id
required: true
schema:
type: string
responses:
'200':
description: Get Metadata Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Photo'
links:
GetPhotoById:
$ref: '#/components/links/GetPhotoById'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not Authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'/order/{internalReference}/photos':
get:
tags:
- Get Photo's Metadata
summary: Get Photos metadatas for a given order
operationId: getPhotosByOrder
parameters:
- name: internalReference
in: path
description: Commercial Operator Internal Reference (ReferenceCommandePriseInterneOc)
required: true
schema:
type: string
- name: Authorization
in: header
description: >-
Credentials to authenticate an operator, it is a token
with scheme Negotiate.
required: false
schema:
type: string
- name: X-Request-Id
in: header
description: >-
Unique identifier of the request (uuid type recommended).
required: true
schema:
type: string
minLength: 0
maxLength: 36
- name: X-Client-Id
in: header
description: Building Operator Id
required: true
schema:
type: string
responses:
'200':
description: Get Metadata Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Photo'
links:
GetPhotoById:
$ref: '#/components/links/GetPhotoById'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not Authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'/intervention/{id}/photos':
get:
tags:
- Get Photo's Metadata
summary: Get Photos metadatas for a given itervention
operationId: getPhotosByIntervention
parameters:
- name: id
in: path
description: Intervention id (ReferenceCommandeSousTraitantOI)
required: true
schema:
type: string
- name: Authorization
in: header
description: >-
Credentials to authenticate an operator, it is a token
with scheme Negotiate.
required: false
schema:
type: string
- name: X-Request-Id
in: header
description: >-
Unique identifier of the request (uuid type recommended).
required: true
schema:
type: string
minLength: 0
maxLength: 36
- name: X-Client-Id
in: header
description: Building Operator Id
required: true
schema:
type: string
responses:
'200':
description: Get Metadata Ok
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Photo'
links:
GetPhotoById:
$ref: '#/components/links/GetPhotoById'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not Authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'/photo/{id}':
get:
tags:
- Get Photo
summary: Get Photo
operationId: getPhoto
parameters:
- name: id
in: path
description: photo id
required: true
schema:
type: string
format: uuid
- name: Authorization
in: header
description: >-
Credentials to authenticate an operator, it is a token
with scheme Negotiate.
required: false
schema:
type: string
- name: X-Request-Id
in: header
description: >-
Unique identifier of the request (uuid type recommended).
required: true
schema:
type: string
minLength: 0
maxLength: 36
- name: X-Client-Id
in: header
description: Building Operator Id
required: true
schema:
type: string
responses:
'200':
description: Get Picture Ok
content:
application/jpeg:
schema:
type: string
format: binary
application/png:
schema:
type: string
format: binary
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Not Authorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Resource not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ErrorResponse:
type: object
required:
- code
- description
- message
properties:
message:
type: string
description:
type: string
code:
type: integer
format: int32
Photo:
type: object
required:
- id
- type
- mimeType
- url
properties:
id:
type: string
format: uuid
description: the id of the photo
name:
type: string
description: the name of the photo
date:
type: string
format: 'date-time'
description: the date of the photo
title:
type: string
description: the title of the photo
description:
type: string
description: the description of the photo
type:
type: string
description: the interop type of the Photo (Pb/Pto before/after)
mimeType:
type: string
enum:
- image/png
- image/jpeg
width:
type: integer
description: the width of the Photo in pixels
height:
type: integer
description: the height of the Photo in pixels
size:
type: integer
description: the size of the Photo in bytes
links:
GetPhotoById:
operationId: getPhoto
parameters:
id: '$response.body#/photos/0/id'
description: The `id` value returned in the response can be used as the `id` parameter in `GET /photo/{id}`.