3 description: "serviceCatalog API designed for ONAP Casablanca Release.\nThis API is\
4 \ build from TMF open API17.5. \nOnly operation GET (by id & byList) for resource\
5 \ serviceSpecification is available"
7 title: "API ServiceCatalog"
10 backgroundColor: "#FFFFFF"
12 basePath: "/nbi/api/v3"
16 - "application/json;charset=utf-8"
18 - name: "ServiceSpecification"
21 /serviceSpecification:
24 - "ServiceSpecification"
26 - "application/json;charset=utf-8"
27 operationId: "serviceSpecificationFind"
28 summary: "List service specifications"
29 description: "This operation returns service specifications from a catalog.\n\
30 Only a predefined set of attribute is proposed : Based on SDC limitations,\
31 \ only attributes category and distributionStatus are available for serviceSpecification\
32 \ filtering\nFields attribute could be used to filter attributes retrieved\n\
33 \nSpecific business errors for current operation will be encapsulated in\n\
34 \nHTTP Response 422 Unprocessable entity\n"
40 description: "Field selection - used to filtering the attributes to be retreived"
45 description: "Service Category (filter)"
47 - name: "distributionStatus"
50 description: "Service distribution status (filter)"
54 description: "Success"
58 $ref: "#/definitions/ServiceSpecification"
60 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
61 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
62 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
63 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
66 $ref: "#/definitions/ErrorRepresentation"
68 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
69 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
71 $ref: "#/definitions/ErrorRepresentation"
73 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
74 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
77 $ref: "#/definitions/ErrorRepresentation"
79 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
82 $ref: "#/definitions/ErrorRepresentation"
84 description: "Unprocessable entity\n\nFunctional error"
86 $ref: "#/definitions/ErrorRepresentation"
88 description: "Internal Server Error\n\nList of supported error codes:\n\
91 $ref: "#/definitions/ErrorRepresentation"
93 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
94 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
97 $ref: "#/definitions/ErrorRepresentation"
98 /serviceSpecification/{id}:
101 - "ServiceSpecification"
103 - "application/json;charset=utf-8"
104 operationId: "serviceSpecificationGet"
105 summary: "Retrieve a service specification"
106 description: "This operation returns a service specification by its id from\
107 \ a catalog. Attribute selection is enabled using the fields attribute.\n\n\
108 Specific business errors for current operation will be encapsulated in\n\n\
109 HTTP Response 422 Unprocessable entity\n"
120 description: "Attribute selection"
124 description: "Success"
126 $ref: "#/definitions/ServiceSpecification"
128 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
129 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
130 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
131 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
134 $ref: "#/definitions/ErrorRepresentation"
136 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
137 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
139 $ref: "#/definitions/ErrorRepresentation"
141 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
142 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
145 $ref: "#/definitions/ErrorRepresentation"
147 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
150 $ref: "#/definitions/ErrorRepresentation"
152 description: "Unprocessable entity\n\nFunctional error"
154 $ref: "#/definitions/ErrorRepresentation"
156 description: "Internal Server Error\n\nList of supported error codes:\n\
159 $ref: "#/definitions/ErrorRepresentation"
161 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
162 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
165 $ref: "#/definitions/ErrorRepresentation"
167 LifecycleStatusValues:
168 description: "Service lifecycle value from ONAP SDC"
171 - "NOT_CERTIFIED_CHECKOUT"
172 - "NOT_CERTIFIED_CHECKIN"
173 - "READY_FOR_CERTIFICATION"
174 - "CERTIFICATION_IN_PROGRESS"
177 description: "Service distribution status from ONAP."
180 - "DISTRIBUTION_NOT_APPROVED"
181 - "DISTRIBUTION_APPROVED"
183 - "DISTRIBUTION_REJECTED"
185 description: "This class is used to describe error.\nfor nbi Beijing release we\
186 \ do not manage additional error for serviceCatalog"
193 description: "Application related code (as defined in the API or from a common\
198 description: "Text that explains the reason for error. This can be shown to\
202 description: "Text that provide more details and corrective actions related\
203 \ to the error. This can be shown to a client user"
206 description: "http error code extension like 400-2"
209 description: "url pointing to documentation describing the error"
212 description: "The class type of a REST resource."
215 description: "it provides a link to the schema describing a REST resource."
218 description: "A time period"
222 description: "Start date and time of the period"
226 description: "End date and time of the period"
230 description: "Party linked to the service catalog.\nin nbi we retrieve information\
231 \ about last updater of the service in SDC"
235 description: "Unique identifier of the related party. Filled with lastUpdaterUserId"
238 description: "Role payed by the related party\nOnly role 'lastUpdater' is\
239 \ retrieved in Beijing release"
242 description: "Name of the related party - Filled with lastUpdatedFullName"
244 ServiceSpecification:
245 description: "ServiceSpecification is a class that offers characteristics to describe\
246 \ a type of service. Functionally, it acts as a template by which Services may\
247 \ be instantiated. By sharing the same specification, these services would therefore\
248 \ share the same set of characteristics.\nthe service information are retrieved\
255 description: "Unique identifier of the service specification. Filled with\
259 description: "Reference of the service specification- not mapped in Beijing"
262 description: "Name of the service specification- Filled with SDC Service name"
265 description: "A narrative that explains in detail what the service specification\
266 \ is - Filled with SDC Service description"
269 description: "This attribute allows to dynamically extends TMF class. Valued\
270 \ with 'ONAPservice'. We used this features to add following attributes:\n\
271 invariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory\
272 \ (1)\ndistributionStatus"
274 default: "ONAPservice"
276 description: "Not used for Beijing release"
279 description: "Not used for Beijing release"
282 description: "Additional attribute (not in the TMF API) - extended through\
283 \ @type - invariantUUID"
286 description: "Additional attribute (not in the TMF API) - extended through\
287 \ @type - toscaModelURL"
290 description: "Additional attribute (not in the TMF API) - extended through\
291 \ @type - toscaResourceName"
294 description: "Additional attribute - extended through @type - category\nPlease\
295 \ note that this attribute is managed in TMF - in future release we'll introduce\
299 description: "Additional attribute - extended through @type - category\nPlease\
300 \ note that this attribute is managed in TMF - in future release we'll introduce\
304 $ref: "#/definitions/DistributionStatus"
306 description: "Service specification version - Filled with SDC Service version"
309 $ref: "#/definitions/LifecycleStatusValues"
311 $ref: "#/definitions/TargetServiceSchemaRef"
315 $ref: "#/definitions/Attachment"
319 $ref: "#/definitions/RelatedPartyRef"
320 resourceSpecification:
323 $ref: "#/definitions/ResourceSpecificationRef"
324 serviceSpecCharacteristic:
327 $ref: "#/definitions/ServiceSpecCharacteristic"
328 ServiceSpecCharacteristic:
329 description: "A characteristic quality or distinctive feature of a ServiceSpecification.\
330 \ \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the\
331 \ topology_template section in the inputs section."
335 description: "Name of the characteristic - Filled with parameter_name"
338 description: "A narrative that explains in detail what the characteristic\
339 \ is - Filled with parameter_description"
342 description: "A kind of value that the characteristic can take on, such as\
343 \ numeric, text and so forth - Filled with parameter_type"
346 description: "This attribute allows to dynamically extends TMF class. Valued\
347 \ with: 'ONAPserviceCharacteristic'. We do not used this features in nbi\
351 description: "An url pointing to type description - we do not use it in nbi\
355 description: "A parameter to define if the characteristic is mandatory - Filled\
356 \ from parameter_required – if not fielded by default ‘true’"
360 description: "Status of the characteristic - filled with status_value"
362 serviceSpecCharacteristicValue:
365 $ref: "#/definitions/ServiceSpecCharacteristicValue"
367 description: "An attachment is a file uses to describe the service.\nIn nbi we\
368 \ use attachment to retrieve ONAP artifacts."
372 description: "Unique identifier of the attachment - filled with artifactUUID."
375 description: "Name of the attachment - filled with artifactName"
378 description: "Description of the attachment - filled with artifactDescription"
381 description: "This attribute allows to dynamically extends TMF class. Valued\
382 \ with 'ONAPartifact'. We used this features to add following attributes:\
383 \ \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\n\
384 artifactVersion\ngeneratedFromUUID"
386 default: "ONAPartifact"
388 description: "Additional attribute (not in the TMF API) - extended through\
389 \ @type - artifactLabel"
392 description: "Additional attribute (not in the TMF API) - extended through\
393 \ @type - artifactGroupType"
396 description: "Additional attribute (not in the TMF API) - extended through\
397 \ @type - artifactTimeout"
400 description: "Additional attribute (not in the TMF API) - extended through\
401 \ @type - artifactChecksum"
404 description: "Additional attribute (not in the TMF API) - extended through\
405 \ @type - artifactVersion"
408 description: "Additional attribute (not in the TMF API) - extended through\
409 \ @type - generatedFromUUID"
412 description: "Uniform Resource Locator, is a web page address - filled with\
416 description: "Filled with artifactType"
418 ServiceSpecCharacteristicValue:
419 description: "A number or text that can be assigned to a service specification\
420 \ characteristic.\nServiceSpecCharacteristicValue are retrieved in the service\
425 description: "A kind of value that the characteristic can take on, such as\
426 \ numeric, text, and so forth\nRetrieved in the Tosca in the topology_template\
427 \ section in the inputs section - parameter_type. \nWe do not manage parameter_type=\
428 \ list or map for Beijing release"
431 description: "Information calculated from parameter default in the Tosca file"
434 description: "A discrete value that the characteristic can take on"
436 ResourceSpecificationRef:
437 description: "A list of resourceSpec identified to deliver the service.\nfor nbi\
438 \ we retrieve resource information available in service description (through\
439 \ SDC api) bu as well information retrieved in the TOSCA file."
443 description: "Unique identifier of the resource specification - filled with\
447 description: "Version for this resource specification - filled with resourceVersion"
450 description: "Name of the resource specification - filled with resourceName"
453 description: "This attribute allows to dynamically extends TMF class. Valued\
454 \ with: 'ONAPresource'. We used this features to add following attributes:\n\
455 resourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\n\
456 modelCustomizationId"
458 default: "ONAPresource"
459 resourceInstanceName:
460 description: "Additional attribute (not in the TMF API) - extended through\
461 \ @type - resourceInstanceName"
463 resourceInvariantUUID:
464 description: "Additional attribute (not in the TMF API) - extended through\
465 \ @type - resourceInvariantUUID"
468 description: "Additional attribute (not in the TMF API) - extended through\
469 \ @type - resoucreType"
471 modelCustomizationName:
472 description: "Additional attribute (not in the TMF API) - extended through\
473 \ @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template\
476 modelCustomizationId:
477 description: "Additional attribute (not in the TMF API) - extended through\
478 \ @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template\
481 TargetServiceSchemaRef: