1 # This work is licensed under a Creative Commons Attribution 4.0 International License.
2 # http://creativecommons.org/licenses/by/4.0
3 # Copyright 2018 Orange
7 description: "serviceCatalog API designed for ONAP Beijing Release.\nThis API is\
8 \ build from TMF open API17.5\nonly operation GET (by id & byList) for resource\
9 \ serviceSpecification is available"
11 title: "API ServiceCatalog"
13 basePath: "/nbi/api/v1"
17 - "application/json;charset=utf-8"
19 - "application/json;charset=utf-8"
21 - name: "ServiceSpecification"
24 /serviceSpecification:
27 - "ServiceSpecification"
28 operationId: "serviceSpecificationFind"
29 summary: "List service specifications"
30 description: "This operation returns service specifications from a catalog.\n\
31 Only a predefined set of attribute is proposed : Based on SDC limitations,\
32 \ only attributes category and distributionStatus are available for serviceSpecification\
33 \ filtering\nFields attribute could be used to filter attributes retrieved\n\
34 \nSpecific business errors for current operation will be encapsulated in\n\
35 \nHTTP Response 422 Unprocessable entity\n"
41 description: "Field selection - used to filtering the attributes to be retreived"
46 description: "Service Category (filter)"
48 - name: "distributionStatus"
51 description: "Service distribution status (filter)"
55 description: "Success"
59 $ref: "#/definitions/ServiceSpecification"
61 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
62 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
63 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
64 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
67 $ref: "#/definitions/ErrorRepresentation"
69 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
70 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
72 $ref: "#/definitions/ErrorRepresentation"
74 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
75 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
78 $ref: "#/definitions/ErrorRepresentation"
80 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
83 $ref: "#/definitions/ErrorRepresentation"
85 description: "Unprocessable entity\n\nFunctional error"
87 $ref: "#/definitions/ErrorRepresentation"
89 description: "Internal Server Error\n\nList of supported error codes:\n\
92 $ref: "#/definitions/ErrorRepresentation"
94 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
95 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
98 $ref: "#/definitions/ErrorRepresentation"
99 /serviceSpecification/{id}:
102 - "ServiceSpecification"
103 operationId: "serviceSpecificationGet"
104 summary: "Retrieve a service specification"
105 description: "This operation returns a service specification by its id from\
106 \ a catalog. Attribute selection is enabled using the fields attribute.\n\n\
107 Specific business errors for current operation will be encapsulated in\n\n\
108 HTTP Response 422 Unprocessable entity\n"
119 description: "Attribute selection"
123 description: "Success"
125 $ref: "#/definitions/ServiceSpecification"
127 description: "Bad Request\n\nList of supported error codes:\n- 20: Invalid\
128 \ URL parameter value\n- 21: Missing body\n- 22: Invalid body\n- 23: Missing\
129 \ body field\n- 24: Invalid body field\n- 25: Missing header\n- 26: Invalid\
130 \ header value\n- 27: Missing query-string parameter\n- 28: Invalid query-string\
133 $ref: "#/definitions/ErrorRepresentation"
135 description: "Unauthorized\n\nList of supported error codes:\n- 40: Missing\
136 \ credentials\n- 41: Invalid credentials\n- 42: Expired credentials"
138 $ref: "#/definitions/ErrorRepresentation"
140 description: "Forbidden\n\nList of supported error codes:\n- 50: Access\
141 \ denied\n- 51: Forbidden requester\n- 52: Forbidden user\n- 53: Too many\
144 $ref: "#/definitions/ErrorRepresentation"
146 description: "Not Found\n\nList of supported error codes:\n- 60: Resource\
149 $ref: "#/definitions/ErrorRepresentation"
151 description: "Unprocessable entity\n\nFunctional error"
153 $ref: "#/definitions/ErrorRepresentation"
155 description: "Internal Server Error\n\nList of supported error codes:\n\
158 $ref: "#/definitions/ErrorRepresentation"
160 description: "Service Unavailable\n\nList of supported error codes:\n- 5:\
161 \ The service is temporarily unavailable\n- 6: Orange API is over capacity,\
164 $ref: "#/definitions/ErrorRepresentation"
166 LifecycleStatusValues:
167 description: "Service lifecycle value from ONAP SDC"
170 - "NOT_CERTIFIED_CHECKOUT"
171 - "NOT_CERTIFIED_CHECKIN"
172 - "READY_FOR_CERTIFICATION"
173 - "CERTIFICATION_IN_PROGRESS"
176 description: "Service distribution status from ONAP."
179 - "DISTRIBUTION_NOT_APPROVED"
180 - "DISTRIBUTION_APPROVED"
182 - "DISTRIBUTION_REJECTED"
184 description: "This class is used to describe error.\nfor nbi Beijing release we\
185 \ do not manage additional error for serviceCatalog"
192 description: "Application related code (as defined in the API or from a common\
197 description: "Text that explains the reason for error. This can be shown to\
201 description: "Text that provide more details and corrective actions related\
202 \ to the error. This can be shown to a client user"
205 description: "http error code extension like 400-2"
208 description: "url pointing to documentation describing the error"
211 description: "The class type of a REST resource."
214 description: "it provides a link to the schema describing a REST resource."
217 description: "A time period"
221 description: "Start date and time of the period"
225 description: "End date and time of the period"
229 description: "Party linked to the service catalog.\nin nbi we retrieve information\
230 \ about last updater of the service in SDC"
234 description: "Unique identifier of the related party. Filled with lastUpdaterUserId"
237 description: "Role payed by the related party\nOnly role 'lastUpdater' is\
238 \ retrieved in Beijing release"
241 description: "Name of the related party - Filled with lastUpdatedFullName"
243 ServiceSpecification:
244 description: "ServiceSpecification is a class that offers characteristics to describe\
245 \ a type of service. Functionally, it acts as a template by which Services may\
246 \ be instantiated. By sharing the same specification, these services would therefore\
247 \ share the same set of characteristics.\nthe service information are retrieved\
254 description: "Unique identifier of the service specification. Filled with\
258 description: "Reference of the service specification- not mapped in Beijing"
261 description: "Name of the service specification- Filled with SDC Service name"
264 description: "A narrative that explains in detail what the service specification\
265 \ is - Filled with SDC Service description"
268 description: "This attribute allows to dynamically extends TMF class. Valued\
269 \ with 'ONAPservice'. We used this features to add following attributes:\n\
270 invariantUUID\ntoscaModelURL\ntoscaResourceName\ncategory (1)\nsubcategory\
271 \ (1)\ndistributionStatus"
273 default: "ONAPservice"
275 description: "Not used for Beijing release"
278 description: "Not used for Beijing release"
281 description: "Additional attribute (not in the TMF API) - extended through\
282 \ @type - invariantUUID"
285 description: "Additional attribute (not in the TMF API) - extended through\
286 \ @type - toscaModelURL"
289 description: "Additional attribute (not in the TMF API) - extended through\
290 \ @type - toscaResourceName"
293 description: "Additional attribute - extended through @type - category\nPlease\
294 \ note that this attribute is managed in TMF - in future release we'll introduce\
298 description: "Additional attribute - extended through @type - category\nPlease\
299 \ note that this attribute is managed in TMF - in future release we'll introduce\
303 $ref: "#/definitions/DistributionStatus"
305 description: "Service specification version - Filled with SDC Service version"
308 $ref: "#/definitions/LifecycleStatusValues"
310 $ref: "#/definitions/TargetServiceSchemaRef"
314 $ref: "#/definitions/Attachment"
318 $ref: "#/definitions/RelatedPartyRef"
319 resourceSpecification:
322 $ref: "#/definitions/ResourceSpecificationRef"
323 serviceSpecCharacteristic:
326 $ref: "#/definitions/ServiceSpecCharacteristic"
327 ServiceSpecCharacteristic:
328 description: "A characteristic quality or distinctive feature of a ServiceSpecification.\
329 \ \nServiceSpecCharacteristic are retrieved in the serviceTosca file in the\
330 \ topology_template section in the inputs section."
334 description: "Name of the characteristic - Filled with parameter_name"
337 description: "A narrative that explains in detail what the characteristic\
338 \ is - Filled with parameter_description"
341 description: "A kind of value that the characteristic can take on, such as\
342 \ numeric, text and so forth - Filled with parameter_type"
345 description: "This attribute allows to dynamically extends TMF class. Valued\
346 \ with: 'ONAPserviceCharacteristic'. We do not used this features in nbi\
350 description: "An url pointing to type description - we do not use it in nbi\
354 description: "A parameter to define if the characteristic is mandatory - Filled\
355 \ from parameter_required – if not fielded by default ‘true’"
359 description: "Status of the characteristic - filled with status_value"
361 serviceSpecCharacteristicValue:
364 $ref: "#/definitions/ServiceSpecCharacteristicValue"
366 description: "An attachment is a file uses to describe the service.\nIn nbi we\
367 \ use attachment to retrieve ONAP artifacts."
371 description: "Unique identifier of the attachment - filled with artifactUUID."
374 description: "Name of the attachment - filled with artifactName"
377 description: "Description of the attachment - filled with artifactDescription"
380 description: "This attribute allows to dynamically extends TMF class. Valued\
381 \ with 'ONAPartifact'. We used this features to add following attributes:\
382 \ \nartifactLabel\nartifactGroupType\nartifactTimeout\nartifactChecksum\n\
383 artifactVersion\ngeneratedFromUUID"
385 default: "ONAPartifact"
387 description: "Additional attribute (not in the TMF API) - extended through\
388 \ @type - artifactLabel"
391 description: "Additional attribute (not in the TMF API) - extended through\
392 \ @type - artifactGroupType"
395 description: "Additional attribute (not in the TMF API) - extended through\
396 \ @type - artifactTimeout"
399 description: "Additional attribute (not in the TMF API) - extended through\
400 \ @type - artifactChecksum"
403 description: "Additional attribute (not in the TMF API) - extended through\
404 \ @type - artifactVersion"
407 description: "Additional attribute (not in the TMF API) - extended through\
408 \ @type - generatedFromUUID"
411 description: "Uniform Resource Locator, is a web page address - filled with\
415 description: "Filled with artifactType"
417 ServiceSpecCharacteristicValue:
418 description: "A number or text that can be assigned to a service specification\
419 \ characteristic.\nServiceSpecCharacteristicValue are retrieved in the service\
424 description: "A kind of value that the characteristic can take on, such as\
425 \ numeric, text, and so forth\nRetrieved in the Tosca in the topology_template\
426 \ section in the inputs section - parameter_type. \nWe do not manage parameter_type=\
427 \ list or map for Beijing release"
430 description: "Information calculated from parameter default in the Tosca file"
433 description: "A discrete value that the characteristic can take on"
435 ResourceSpecificationRef:
436 description: "A list of resourceSpec identified to deliver the service.\nfor nbi\
437 \ we retrieve resource information available in service description (through\
438 \ SDC api) bu as well information retrieved in the TOSCA file."
442 description: "Unique identifier of the resource specification - filled with\
446 description: "Version for this resource specification - filled with resourceVersion"
449 description: "Name of the resource specification - filled with resourceName"
452 description: "This attribute allows to dynamically extends TMF class. Valued\
453 \ with: 'ONAPresource'. We used this features to add following attributes:\n\
454 resourceInstanceName\nresourceInvariantUUID\nresourceType\nmodelCustomizationName\n\
455 modelCustomizationId"
457 default: "ONAPresource"
458 resourceInstanceName:
459 description: "Additional attribute (not in the TMF API) - extended through\
460 \ @type - resourceInstanceName"
462 resourceInvariantUUID:
463 description: "Additional attribute (not in the TMF API) - extended through\
464 \ @type - resourceInvariantUUID"
467 description: "Additional attribute (not in the TMF API) - extended through\
468 \ @type - resoucreType"
470 modelCustomizationName:
471 description: "Additional attribute (not in the TMF API) - extended through\
472 \ @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template\
475 modelCustomizationId:
476 description: "Additional attribute (not in the TMF API) - extended through\
477 \ @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template\
480 TargetServiceSchemaRef: