Gitiles
Code Review Sign In
gerrit.nordix.org / onap / sdc / 091edfdac90f66d91caff1b93131f99ba74f9aeb / . / services / activity-spec / swagger-ui / api-docs / api.html
blob: 8ec70b32cf024215a6b6a820008516fa9b99adb3 [file] [log] [blame]
sheetalm297209b2018-02-20 19:06:27 +0530[diff] [blame]1<!DOCTYPE html>
2<html>
3<title>API Document</title>
4
5<!--xmp theme="united" style="display:none;"-->
6<xmp theme="united" style="display:none;">
7#Rest API
8
9
10## HTTP:///activityspec-api
11
12
13Rest API Documentation
14
15
16
17**Version** v1.0, build #${buildNumber}
18
19
20
21
22
23
24
25
26
27
28
29
30# APIs
31
32
33## /v1.0/activity-spec
34
35
36### GET
37
38<a id="list">Get list of activity specs </a>
39
40
41
42
43
44
45
46
47
48#### Request
49
50
51**Content-Type: ** application/json
52
53##### Parameters
54
55<table border="1">
56 <tr>
57 <th>Name</th>
58 <th>Located in</th>
59 <th>Required</th>
60 <th>Description</th>
61 <th>Default</th>
62 <th>Schema</th>
63 </tr>
64
65
66
67<tr>
68 <th>status</th>
69 <td>query</td>
70 <td>no</td>
71 <td>Currently supported values: &#x27;Certified&#x27; - only activity specs with Certified status</td>
72 <td> - </td>
73
74
75 <td>string </td>
76
77
78</tr>
79
80<tr>
81 <th>USER_ID</th>
82 <td>header</td>
83 <td>no</td>
84 <td></td>
85 <td> - </td>
86
87
88 <td>string </td>
89
90
91</tr>
92
93
94</table>
95
96
97
98#### Response
99
100**Content-Type: ** application/json
101
102
103| Status Code | Reason | Response Model |
104|-------------|-------------|----------------|
105| default | successful operation | - |
106
107
108
109
110
111
112### POST
113
114
115<a id="createActivitySpec">Create Activity Spec</a>
116
117
118
119
120
121
122
123
124
125#### Request
126
127
128**Content-Type: ** application/json
129
130##### Parameters
131
132<table border="1">
133 <tr>
134 <th>Name</th>
135 <th>Located in</th>
136 <th>Required</th>
137 <th>Description</th>
138 <th>Default</th>
139 <th>Schema</th>
140 </tr>
141
142
143
144<tr>
145 <th>body</th>
146 <td>body</td>
147 <td>no</td>
148 <td></td>
149 <td> - </td>
150
151 <td>
152
153 <a href="#/definitions/ActivitySpecRequest">ActivitySpecRequest</a>
154 </td>
155
156</tr>
157
158<tr>
159 <th>USER_ID</th>
160 <td>header</td>
161 <td>no</td>
162 <td></td>
163 <td> - </td>
164
165
166 <td>string </td>
167
168
169</tr>
170
171
172</table>
173
174
175
176#### Response
177
178**Content-Type: ** application/json
179
180
181| Status Code | Reason | Response Model |
182|-------------|-------------|----------------|
183| default | successful operation | - |
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198## /v1.0/activity-spec/{id}/versions/{versionId}
199
200
201### GET
202
203<a id="getActivitySpec">Get Activity Spec</a>
204
205
206
207
208
209
210
211
212
213#### Request
214
215
216**Content-Type: ** application/json
217
218##### Parameters
219
220<table border="1">
221 <tr>
222 <th>Name</th>
223 <th>Located in</th>
224 <th>Required</th>
225 <th>Description</th>
226 <th>Default</th>
227 <th>Schema</th>
228 </tr>
229
230
231
232<tr>
233 <th>id</th>
234 <td>path</td>
235 <td>yes</td>
236 <td>Activity Spec Id</td>
237 <td> - </td>
238
239
240 <td>string </td>
241
242
243</tr>
244
245<tr>
246 <th>versionId</th>
247 <td>path</td>
248 <td>yes</td>
249 <td>Version Id</td>
250 <td> - </td>
251
252
253 <td>string </td>
254
255
256</tr>
257
258<tr>
259 <th>USER_ID</th>
260 <td>header</td>
261 <td>no</td>
262 <td></td>
263 <td> - </td>
264
265
266 <td>string </td>
267
268
269</tr>
270
271
272</table>
273
274
275
276#### Response
277
278**Content-Type: ** application/json
279
280
281| Status Code | Reason | Response Model |
282|-------------|-------------|----------------|
283| default | successful operation | - |
284
285
286
287
288### PUT
289
290<a id="updateActivitySpec">Update Activity Spec</a>
291
292
293
294
295
296
297
298
299
300#### Request
301
302
303**Content-Type: ** application/json
304
305##### Parameters
306
307<table border="1">
308 <tr>
309 <th>Name</th>
310 <th>Located in</th>
311 <th>Required</th>
312 <th>Description</th>
313 <th>Default</th>
314 <th>Schema</th>
315 </tr>
316
317
318
319<tr>
320 <th>body</th>
321 <td>body</td>
322 <td>no</td>
323 <td></td>
324 <td> - </td>
325
326 <td>
327
328 <a href="#/definitions/ActivitySpecRequest">ActivitySpecRequest</a>
329 </td>
330
331</tr>
332
333<tr>
334 <th>id</th>
335 <td>path</td>
336 <td>yes</td>
337 <td>Activity Spec Id</td>
338 <td> - </td>
339
340
341 <td>string </td>
342
343
344</tr>
345
346<tr>
347 <th>versionId</th>
348 <td>path</td>
349 <td>yes</td>
350 <td>Version Id</td>
351 <td> - </td>
352
353
354 <td>string </td>
355
356
357</tr>
358
359<tr>
360 <th>USER_ID</th>
361 <td>header</td>
362 <td>no</td>
363 <td></td>
364 <td> - </td>
365
366
367 <td>string </td>
368
369
370</tr>
371
372
373</table>
374
375
376
377#### Response
378
379**Content-Type: ** application/json
380
381
382| Status Code | Reason | Response Model |
383|-------------|-------------|----------------|
384| default | successful operation | - |
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400## /v1.0/activity-spec/{id}/versions/{versionId}/actions
401
402
403
404
405### PUT
406
407<a id="actOnActivitySpec">Actions on a activity spec</a>
408
409Performs one of the following actions on a activity spec: |Submit: Finalize its active version.|Deprecate: Deprecate activity spec.|
410
411
412
413
414
415
416
417#### Request
418
419
420**Content-Type: ** application/json
421
422##### Parameters
423
424<table border="1">
425 <tr>
426 <th>Name</th>
427 <th>Located in</th>
428 <th>Required</th>
429 <th>Description</th>
430 <th>Default</th>
431 <th>Schema</th>
432 </tr>
433
434
435
436<tr>
437 <th>body</th>
438 <td>body</td>
439 <td>no</td>
440 <td></td>
441 <td> - </td>
442
443 <td>
444
445 <a href="#/definitions/ActivitySpecActionRequestDto">ActivitySpecActionRequestDto</a>
446 </td>
447
448</tr>
449
450<tr>
451 <th>id</th>
452 <td>path</td>
453 <td>yes</td>
454 <td>Activity Spec Id</td>
455 <td> - </td>
456
457
458 <td>string </td>
459
460
461</tr>
462
463<tr>
464 <th>versionId</th>
465 <td>path</td>
466 <td>yes</td>
467 <td>Version Id</td>
468 <td> - </td>
469
470
471 <td>string </td>
472
473
474</tr>
475
476<tr>
477 <th>USER_ID</th>
478 <td>header</td>
479 <td>no</td>
480 <td></td>
481 <td> - </td>
482
483
484 <td>string </td>
485
486
487</tr>
488
489
490</table>
491
492
493
494#### Response
495
496**Content-Type: ** application/json
497
498
499| Status Code | Reason | Response Model |
500|-------------|-------------|----------------|
501| default | successful operation | - |
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518# Definitions
519
520## <a name="/definitions/ActivitySpecActionRequestDto">ActivitySpecActionRequestDto</a>
521
522<table border="1">
523 <tr>
524 <th>name</th>
525 <th>type</th>
526 <th>required</th>
527 <th>description</th>
528 <th>example</th>
529 </tr>
530
531 <tr>
532 <td>action</td>
533 <td>
534
535
536 string
537
538 </td>
539 <td>optional</td>
540 <td>-</td>
541 <td></td>
542 </tr>
543
544</table>
545
546## <a name="/definitions/ActivitySpecParameterDto">ActivitySpecParameterDto</a>
547
548<table border="1">
549 <tr>
550 <th>name</th>
551 <th>type</th>
552 <th>required</th>
553 <th>description</th>
554 <th>example</th>
555 </tr>
556
557 <tr>
558 <td>name</td>
559 <td>
560
561
562 string
563
564 </td>
565 <td>optional</td>
566 <td>-</td>
567 <td></td>
568 </tr>
569
570 <tr>
571 <td>type</td>
572 <td>
573
574
575 string
576
577 </td>
578 <td>optional</td>
579 <td>-</td>
580 <td></td>
581 </tr>
582
583 <tr>
584 <td>value</td>
585 <td>
586
587
588 string
589
590 </td>
591 <td>optional</td>
592 <td>-</td>
593 <td></td>
594 </tr>
595
596</table>
597
598## <a name="/definitions/ActivitySpecRequest">ActivitySpecRequest</a>
599
600<table border="1">
601 <tr>
602 <th>name</th>
603 <th>type</th>
604 <th>required</th>
605 <th>description</th>
606 <th>example</th>
607 </tr>
608
609 <tr>
610 <td>name</td>
611 <td>
612
613
614 string
615
616 </td>
617 <td>optional</td>
618 <td>-</td>
619 <td></td>
620 </tr>
621
622 <tr>
623 <td>description</td>
624 <td>
625
626
627 string
628
629 </td>
630 <td>optional</td>
631 <td>-</td>
632 <td></td>
633 </tr>
634
635 <tr>
636 <td>categoryList</td>
637 <td>
638
639
640 array[string]
641
642 </td>
643 <td>optional</td>
644 <td>-</td>
645 <td></td>
646 </tr>
647
648 <tr>
649 <td>inputParameters</td>
650 <td>
651
652
653 array[<a href="#/definitions/ActivitySpecParameterDto">ActivitySpecParameterDto</a>]
654
655
656
657 </td>
658 <td>optional</td>
659 <td>-</td>
660 <td></td>
661 </tr>
662
663 <tr>
664 <td>outputParameters</td>
665 <td>
666
667
668 array[<a href="#/definitions/ActivitySpecParameterDto">ActivitySpecParameterDto</a>]
669
670
671
672 </td>
673 <td>optional</td>
674 <td>-</td>
675 <td></td>
676 </tr>
677
678</table>
679
680</xmp>
681
682<script src="http://strapdownjs.com/v/0.2/strapdown.js"></script>
683</html>