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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
|
{
"swagger": "2.0",
"info": {
"description": "ServiceCatalog API to retrieve Service Specifications that are available from ONAP.\nThis API is build from TMF open API version 17.5. \nOnly operation GET (by id & byList) for serviceSpecification resource is available.\n To view this swagger file import it into https://editor.swagger.io/ \n\n",
"version": "4.0.1",
"title": "ServiceCatalog API",
"contact": {
"name": "ONAP",
"url": "https://onap.readthedocs.io",
"email": "onap-discuss@lists.onap.org"
},
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
"x-planned-retirement-date": "205001",
"x-component": "NBI",
"x-logo": {
"url": "/redoc/logo.png",
"backgroundColor": "#FFFFFF"
}
},
"host": "serverRoot:30274",
"basePath": "/nbi/api/v4",
"schemes": [
"http"
],
"produces": [
"application/json;charset=utf-8"
],
"tags": [
{
"name": "ServiceSpecification",
"description": ""
}
],
"paths": {
"/serviceSpecification": {
"get": {
"tags": [
"ServiceSpecification"
],
"produces": [
"application/json;charset=utf-8"
],
"operationId": "serviceSpecification_Find",
"summary": "List service specifications",
"description": "This operation returns service specifications from a catalog.\nOnly a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering\nFields attribute could be used to filter attributes retrieved",
"deprecated": false,
"parameters": [
{
"name": "fields",
"required": false,
"in": "query",
"description": "Field selection - used to filtering the attributes to be retreived",
"type": "string"
},
{
"name": "category",
"required": false,
"in": "query",
"description": "Service Category (filter)",
"type": "string"
},
{
"name": "distributionStatus",
"required": false,
"in": "query",
"description": "Service distribution status (filter)",
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/ServiceSpecification"
}
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"401": {
"description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"403": {
"description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"503": {
"description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/serviceSpecification/{id}": {
"get": {
"tags": [
"ServiceSpecification"
],
"produces": [
"application/json;charset=utf-8"
],
"operationId": "serviceSpecification_Get",
"summary": "Retrieve a service specification",
"description": "This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.",
"deprecated": false,
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"type" : "string"
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/ServiceSpecification"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"401": {
"description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"403": {
"description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"503": {
"description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
},
"/serviceSpecification/{id}/specificationInputSchema": {
"get": {
"tags": [
"ServiceSpecification"
],
"produces": [
"application/json;charset=utf-8"
],
"operationId": "specificationInputSchemaGet",
"summary": "Retrieve a service specification Input Schema",
"description": "This operation returns a service specification Input Schema by its id from a catalog. Attribute selection is enabled using the fields attribute.",
"deprecated": false,
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"type" : "string"
},
{
"name": "fields",
"required": false,
"in": "query",
"description": "Attribute selection",
"type": "string"
}
],
"responses": {
"200": {
"description": "Ok",
"schema": {
"$ref": "#/definitions/SpecificationInputSchema"
}
},
"400": {
"description": "Bad Request\n\nList of supported error codes:\n- 20: Invalid URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string parameter value",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"401": {
"description": "Unauthorized\n\nList of supported error codes:\n- 40: Missing credentials\n- 41: Invalid credentials\n- 42: Expired credentials",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"403": {
"description": "Forbidden\n\nList of supported error codes:\n- 50: Access denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many requests",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"404": {
"description": "Not Found\n\nList of supported error codes:\n- 60: Resource not found",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"422": {
"description": "Unprocessable entity\n\nFunctional error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"500": {
"description": "Internal Server Error\n\nList of supported error codes:\n- 1: Internal error",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
},
"503": {
"description": "Service Unavailable\n\nList of supported error codes:\n- 5: The service is temporarily unavailable\n- 6: Orange API is over capacity, retry later !",
"schema": {
"$ref": "#/definitions/ErrorRepresentation"
}
}
}
}
}
},
"definitions": {
"LifecycleStatusValues": {
"description": "Service lifecycle value from ONAP SDC",
"type": "string",
"enum": [
"NOT_CERTIFIED_CHECKOUT",
"NOT_CERTIFIED_CHECKIN",
"READY_FOR_CERTIFICATION",
"CERTIFICATION_IN_PROGRESS",
"CERTIFIED"]
},
"DistributionStatus": {
"description": "Service distribution status from ONAP.",
"type": "string",
"enum": [
"DISTRIBUTION_NOT_APPROVED",
"DISTRIBUTION_APPROVED",
"DISTRIBUTED",
"DISTRIBUTION_REJECTED"]
},
"ErrorRepresentation": {
"description": "This class is used to describe error.\nfor nbi Beijing release we do not manage additional error for serviceCatalog",
"required": [
"code",
"reason"
],
"type": "object",
"properties": {
"code": {
"description": "Application related code (as defined in the API or from a common list)",
"type": "integer",
"format": "int32"
},
"reason": {
"description": "Text that explains the reason for error. This can be shown to a client user.",
"type": "string"
},
"message": {
"description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user",
"type": "string"
},
"status": {
"description": "http error code extension like 400-2",
"type": "string"
},
"referenceErrror": {
"description": "url pointing to documentation describing the error",
"type": "string"
},
"@type": {
"description": "The class type of a REST resource.",
"type": "string"
},
"@schemaLocation": {
"description": "it provides a link to the schema describing a REST resource.",
"type": "string"
}
}
},
"TimePeriod": {
"description": "A time period",
"type": "object",
"properties": {
"startDateTime": {
"description": "Start date and time of the period",
"type": "string",
"format": "date-time"
},
"endDateTime": {
"description": "End date and time of the period",
"type": "string",
"format": "date-time"
}
}
},
"RelatedPartyRef": {
"description": "Party linked to the service catalog.\nin nbi we retrieve information about last updater of the service in SDC",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the related party. Filled with lastUpdaterUserId",
"type": "string"
},
"role": {
"description": "Role payed by the related party\nOnly role 'lastUpdater' is retrieved in Beijing release",
"type": "string"
},
"name": {
"description": "Name of the related party - Filled with lastUpdatedFullName",
"type": "string"
}
}
},
"ServiceSpecification": {
"description": "ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.\nthe service information are retrieved in SDC",
"required": [
"invariantUUID"
],
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the service specification. Filled with SDC Service uuid",
"type": "string"
},
"href": {
"description": "Reference of the service specification- not mapped in Beijing",
"type": "string"
},
"name": {
"description": "Name of the service specification- Filled with SDC Service name",
"type": "string"
},
"description": {
"description": "A narrative that explains in detail what the service specification is - Filled with SDC Service description",
"type": "string"
},
"@type": {
"description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:\ninvariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory (1)\ndistributionStatus",
"type": "string",
"default": "ONAPservice"
},
"@schemaLocation": {
"description": "Not used",
"type": "string"
},
"@baseType": {
"description": "Not used",
"type": "string"
},
"invariantUUID": {
"description": "Additional attribute (not in the TMF API) - extended through @type - invariantUUID",
"type": "string"
},
"toscaModelURL": {
"description": "Additional attribute (not in the TMF API) - extended through @type - toscaModelURL",
"type": "string"
},
"toscaResourceName": {
"description": "Additional attribute (not in the TMF API) - extended through @type - toscaResourceName",
"type": "string"
},
"category": {
"description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resource",
"type": "string"
},
"subcategory": {
"description": "Additional attribute - extended through @type - category\nPlease note that this attribute is managed in TMF - in future release we'll introduce category resourc",
"type": "string"
},
"distributionStatus": {
"$ref": "#/definitions/DistributionStatus"
},
"version": {
"description": "Service specification version - Filled with SDC Service version",
"type": "string"
},
"lifecycleStatus": {
"$ref": "#/definitions/LifecycleStatusValues"
},
"targetServiceSchema": {
"$ref": "#/definitions/TargetServiceSchemaRef"
},
"attachment": {
"type": "array",
"items": {
"$ref": "#/definitions/Attachment"
}
},
"relatedParty": {
"type": "array",
"items": {
"$ref": "#/definitions/RelatedPartyRef"
}
},
"resourceSpecification": {
"type": "array",
"items": {
"$ref": "#/definitions/ResourceSpecificationRef"
}
},
"serviceSpecCharacteristic": {
"type": "array",
"items": {
"$ref": "#/definitions/ServiceSpecCharacteristic"
}
}
}
},
"ServiceSpecCharacteristic": {
"description": "A characteristic quality or distinctive feature of a ServiceSpecification. \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.",
"type": "object",
"properties": {
"name": {
"description": "Name of the characteristic - Filled with parameter_name",
"type": "string"
},
"description": {
"description": "A narrative that explains in detail what the characteristic is - Filled with parameter_description",
"type": "string"
},
"valueType": {
"description": "A kind of value that the characteristic can take on, from Dublin we use the object type to describe the service characteristic values",
"type": "string"
},
"@type": {
"description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not use this feature in nbi.",
"type": "string"
},
"@schemaLocation": {
"description": "An url pointing to type description - we do not use it",
"type": "string"
},
"required": {
"description": "A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’",
"type": "boolean",
"default": true
},
"status": {
"description": "Status of the characteristic - filled with status_value",
"type": "string"
},
"serviceSpecCharacteristicValue": {
"type": "array",
"items": {
"$ref": "#/definitions/ServiceSpecCharacteristicValue"
}
}
}
},
"Attachment": {
"description": "An attachment is a file uses to describe the service.\nIn nbi we use attachment to retrieve ONAP artifacts.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the attachment - filled with artifactUUID.",
"type": "string"
},
"name": {
"description": "Name of the attachment - filled with artifactName",
"type": "string"
},
"description": {
"description": "Description of the attachment - filled with artifactDescription",
"type": "string"
},
"@type": {
"description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\nartifactVersion\ngeneratedFromUUID",
"type": "string",
"default": "ONAPartifact"
},
"artifactLabel": {
"description": "Additional attribute (not in the TMF API) - extended through @type - artifactLabel",
"type": "string"
},
"artifactGroupType": {
"description": "Additional attribute (not in the TMF API) - extended through @type - artifactGroupType",
"type": "string"
},
"artifactTimeout": {
"description": "Additional attribute (not in the TMF API) - extended through @type - artifactTimeout",
"type": "string"
},
"artifactChecksum": {
"description": "Additional attribute (not in the TMF API) - extended through @type - artifactChecksum",
"type": "string"
},
"artifactVersion": {
"description": "Additional attribute (not in the TMF API) - extended through @type - artifactVersion",
"type": "string"
},
"generatedFromUUID": {
"description": "Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID",
"type": "string"
},
"url": {
"description": "Uniform Resource Locator, is a web page address - filled with artifactURL",
"type": "string"
},
"mimeType": {
"description": "Filled with artifactType",
"type": "string"
}
}
},
"ServiceSpecCharacteristicValue": {
"description": "A number or text that can be assigned to a service specification characteristic.\nServiceSpecCharacteristicValue are retrieved in the service Tosca file",
"type": "object",
"properties": {
"@type": {
"description": "This attribute allows to dynamically extends TMF classes. Valued with: ServiceSpecName_ServiceCharacteristic",
"type": "string"
},
"@schemaLocation": {
"description": "An url pointing to type description - we use this in nbi for specifying the specificationInputSchema url",
"type": "string"
},
"valueType": {
"description": "A kind of value that the characteristic can take on, from Dublin release we use an object valueType to group the Tosca Model Inputs, the object schema is described by the specificationInputSchema url",
"type": "string"
}
}
},
"SpecificationInputSchema": {
"description": "A json schema of the service specification input characteristics.\nThe Inputs in the schema files are obtained the service Tosca file Inputs",
"type": "object",
"properties": {
"ServiceCharacteristics": {
"$ref": "#/definitions/SchemaForServiceCharacteristics"
}
}
},
"SchemaForServiceCharacteristics": {
"description": "The object describing the schema of the service specification input characteristics.\nThe Inputs in the schema files are obtained the service Tosca file Inputs",
"type": "object",
"properties": {
"required": {
"description": "defines the parameter key names that are mandatory to send",
"type": "array",
"items": {
"type": "string"
}
},
"properties": {
"description": "defines all the input key names and types for the Service Instantiation",
"type": "object"
}
}
},
"ResourceSpecificationRef": {
"description": "A list of resourceSpec identified to deliver the service.\nfor nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier of the resource specification - filled with resourceUUID",
"type": "string"
},
"version": {
"description": "Version for this resource specification - filled with resourceVersion",
"type": "string"
},
"name": {
"description": "Name of the resource specification - filled with resourceName",
"type": "string"
},
"@type": {
"description": "This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:\nresourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\nmodelCustomizationId",
"type": "string",
"default": "ONAPresource"
},
"resourceInstanceName": {
"description": "Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName",
"type": "string"
},
"resourceInvariantUUID": {
"description": "Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID",
"type": "string"
},
"resourceType": {
"description": "Additional attribute (not in the TMF API) - extended through @type - resoucreType",
"type": "string"
},
"modelCustomizationName": {
"description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource",
"type": "string"
},
"modelCustomizationId": {
"description": "Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource",
"type": "string"
}
}
},
"TargetServiceSchemaRef": {
"description": "",
"required": [
"@type",
"@schemaLocation"
],
"type": "object",
"properties": {
"@type": {
"description": "",
"type": "string"
},
"@schemaLocation": {
"description": "",
"type": "string"
}
}
}
}
}
|
