summaryrefslogtreecommitdiffstats
path: root/docs/offeredapis/serviceInventory/asciiDoc.adoc
blob: e34ec4434f763f1e5143d3dde821de0e5a48af9b (plain)
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
= API ServiceInventory


[[_overview]]
== Overview

=== Api URL

https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json[Swagger UI]


https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0[plant UML UI]

serviceInventory API designed for ONAP Beijing Release.
This API is build from TMF open API18.0 (applying TMF Guideline 3.0)
only operation GET (by id & byList) for resource serviceSpecification is available


=== Version information
[%hardbreaks]
__Version__ : 3.0.0_inProgress


=== URI scheme
[%hardbreaks]
__Host__ : serverRoot
__BasePath__ : /nbi/api/v3
__Schemes__ : HTTPS


=== Tags

* Service


=== Produces

* `application/json;charset=utf-8`


[[_paths]]
== Resources

[[_service_resource]]
=== Service

[[_servicefind]]
==== List services
....
GET /service
....


===== Description
This operation list service entities.
Attribute selection is restricted.
fields attribute may be used to filter retrieved attribute(s) for each service

Specific business errors for current operation will be encapsulated in

HTTP Response 422 Unprocessable entity


===== Parameters

[options="header", cols=".^2,.^3,.^4"]
|===
|Type|Name|Schema
|**Query**|**fields** +
__optional__|string
|**Query**|**id** +
__optional__|string
|**Query**|**relatedParty.id** +
__optional__|string
|**Query**|**serviceSpecification.id** +
__optional__|string
|**Query**|**serviceSpecification.name** +
__optional__|string
|===


===== Responses

[options="header", cols=".^2,.^14,.^4"]
|===
|HTTP Code|Description|Schema
|**200**|Success|< <<_listservice,ListService>> > array
|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
|**404**|Not Found

List of supported error codes:
- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
|**422**|Unprocessable entity

Functional error|<<_errorrepresentation,ErrorRepresentation>>
|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
|===


===== Produces

* `application/json;charset=utf-8`


[[_serviceget]]
==== Retrieve a service
....
GET /service/{id}
....


===== Description
This operation retrieves a service entity.
Attribute selection is enabled for all first level attributes.

Specific business errors for current operation will be encapsulated in

HTTP Response 422 Unprocessable entity


===== Parameters

[options="header", cols=".^2,.^3,.^4"]
|===
|Type|Name|Schema
|**Path**|**id** +
__required__|string
|**Query**|**relatedParty.id** +
__optional__|string
|**Query**|**serviceSpecification.id** +
__optional__|string
|**Query**|**serviceSpecification.name** +
__optional__|string
|===


===== Responses

[options="header", cols=".^2,.^14,.^4"]
|===
|HTTP Code|Description|Schema
|**200**|Success|<<_service,Service>>
|**400**|Bad Request

List of supported error codes:
- 20: Invalid URL parameter value
- 21: Missing body
- 22: Invalid body
- 23: Missing body field
- 24: Invalid body field
- 25: Missing header
- 26: Invalid header value
- 27: Missing query-string parameter
- 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
|**401**|Unauthorized

List of supported error codes:
- 40: Missing credentials
- 41: Invalid credentials
- 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
|**403**|Forbidden

List of supported error codes:
- 50: Access denied
- 51: Forbidden requester
- 52: Forbidden user
- 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
|**404**|Not Found

List of supported error codes:
- 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
|**422**|Unprocessable entity

Functional error|<<_errorrepresentation,ErrorRepresentation>>
|**500**|Internal Server Error

List of supported error codes:
- 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
|**503**|Service Unavailable

List of supported error codes:
- 5: The service is temporarily unavailable
- 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
|===


===== Produces

* `application/json;charset=utf-8`


[[_definitions]]
== Definitions

[[_errorrepresentation]]
=== ErrorRepresentation
This class is used to describe error.
for nbi Beijing release we do not manage additional error for serviceCatalog


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**@schemaLocation** +
__optional__|it provides a link to the schema describing a REST resource.|string
|**@type** +
__optional__|The class type of a REST resource.|string
|**code** +
__required__|Application related code (as defined in the API or from a common list)|integer (int32)
|**message** +
__optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user.|string
|**reason** +
__required__|Text that explains the reason for error. This can be shown to a client user.|string
|**referenceError** +
__optional__|url pointing to documentation describing the error|string
|**status** +
__optional__|http error code extension like 400-2|string
|===


[[_listrelatedpartyref]]
=== ListRelatedPartyRef
This class is used to structure list of service(s) retrieved


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**id** +
__optional__|Unique identifier of a related party|string
|**role** +
__optional__|Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.|string
|===


[[_listservice]]
=== ListService
This class is used to structure list of service(s) retrieved


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**id** +
__optional__|Unique identifier of the service|string
|**name** +
__optional__|Name of the service|string
|**relatedParty** +
__optional__||<<_listrelatedpartyref,ListRelatedPartyRef>>
|**serviceSpecification** +
__optional__||<<_listservicespecificationref,ListServiceSpecificationRef>>
|===


[[_listservicespecificationref]]
=== ListServiceSpecificationRef
This class is used to structure list of service(s) retrieved


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**id** +
__optional__|Unique identifier of the service specification|string
|**name** +
__optional__|Name of the required service specification|string
|===


[[_relatedpartyref]]
=== RelatedPartyRef
RelatedParty reference. A related party defines party or party role linked to a specific entity.
Only ONAP Customer is managed in Beijing release.


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**@referredType** +
__optional__|Not managed in the Beijing release.|string
|**href** +
__optional__|Reference of a related party.
Not filled in Beijing release.|string
|**id** +
__optional__|Unique identifier of a related party|string
|**role** +
__optional__|Role played by the related party.
Filled with 'ONAPcustomer'|string
|===


[[_service]]
=== Service
Instantiated service (service_instance) in AAI


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**@baseType** +
__optional__|Not managed in Beijing release|string
|**@schemaLocation** +
__optional__|Not managed in Beijing release|string
|**@type** +
__optional__|This attribute allows to dynamically extends TMF class. Not used in Beijing release.|string
|**characteristic** +
__optional__||< <<_servicecharacteristic,ServiceCharacteristic>> > array
|**hasStarted** +
__optional__|This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started
Not managed in Beijing release|boolean
|**href** +
__optional__|Reference of the service
Not managed in Beijing release|string
|**id** +
__optional__|Unique identifier of the service - Valued with service-instance-id|string
|**name** +
__optional__|Name of the service - Valued with service-instance-name|string
|**relatedParty** +
__optional__||< <<_relatedpartyref,RelatedPartyRef>> > array
|**serviceSpecification** +
__optional__||<<_servicespecificationref,ServiceSpecificationRef>>
|**state** +
__optional__|State of the service. Not managed in Beijing release|string
|**supportingResource** +
__optional__||< <<_supportingresource,SupportingResource>> > array
|**type** +
__optional__|Service type - valued with 'service-instance'|string
|===


[[_servicecharacteristic]]
=== ServiceCharacteristic
A list of name value pairs that define the service characteristics
Not managed in Beijing release.


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**name** +
__required__|Name of the characteristic
Not managed in Beijing release.|string
|**value** +
__optional__||<<_value,Value>>
|**valueType** +
__optional__|Type of value for this characteristic.
Not managed in Beijing release.|string
|===


[[_servicespecificationref]]
=== ServiceSpecificationRef
Service specification reference: ServiceSpecification of this service (catalog information)


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**@referredType** +
__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID|string
|**@schemaLocation** +
__optional__|Not managed in Beijing release|string
|**href** +
__optional__|Reference of the service specification.
not managed in Beijing release.|string
|**id** +
__optional__|Unique identifier of the service specification. valued to model-version-id|string
|**invariantUUID** +
__optional__|Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id|string
|**name** +
__optional__|Name of the required service specification|string
|**version** +
__optional__|Service specification version.
Not managed in Beijing release|string
|===


[[_supportingresource]]
=== SupportingResource
Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**@referredType** +
__optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:
 status
 modelInvariantId
 modelVersionId
 modelCustomisationId|string
|**@schemaLocation** +
__optional__|Not managed in Beijing release.|string
|**href** +
__optional__|Reference of the supporting resource|string
|**id** +
__optional__|Unique identifier of the supporting resource - Valued to vnf-id|string
|**modelCustomisationId** +
__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id|string
|**modelInvariantId** +
__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id|string
|**modelVersionId** +
__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id|string
|**name** +
__optional__|Name of the supporting resource - Valued with vnf_-name|string
|**role** +
__optional__|Not managed in Beijing release.|string
|**status** +
__optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status|string
|===


[[_value]]
=== Value
Structure used to describe characteristic value.
Not managed in Beijing release.


[options="header", cols=".^3,.^11,.^4"]
|===
|Name|Description|Schema
|**@schemaLocation** +
__optional__|Not managed in Beijing release.|string
|**@type** +
__optional__|Not managed in Beijing release.|string
|**serviceCharacteristicValue** +
__optional__|Not managed in Beijing release.|string
|===