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
|
openapi: 3.0.1
info:
title: NCMP DMI Plugin
description: Adds Data Model Inventory Registry capability for ONAP
version: 1.0.0
servers:
- url: /dmi
tags:
- name: dmi-plugin-internal
description: DMI plugin internal rest apis
- name: dmi-plugin
description: DMI plugin rest apis
paths:
/v1/ch/{cmHandle}/modules:
post:
tags:
- dmi-plugin
summary: Get all modules for cm handle
description: Get all modules for given cm handle
operationId: getModuleReferences
parameters:
- name: cmHandle
in: path
description: The cm handle to fetch all the modules
required: true
style: simple
explode: false
schema:
type: string
requestBody:
description: Operational body
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleReferencesRequest'
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleSet'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/ch/{cmHandle}/moduleResources:
post:
tags:
- dmi-plugin
summary: Retrieve module resources
description: Retrieve module resources for one or more modules
operationId: retrieveModuleResources
parameters:
- name: cmHandle
in: path
description: The identifier for a network function, network element, subnetwork,
or any other cm object by managed Network CM Proxy
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleResourcesReadRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/YangResources'
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/inventory/cmHandles:
post:
tags:
- dmi-plugin-internal
summary: register given list of cm handles (internal use only)
description: register given list of cm handles (internal use only)
operationId: registerCmHandles
requestBody:
description: list of cm handles
content:
application/json:
schema:
$ref: '#/components/schemas/CmHandles'
required: true
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
x-api-audience: component-internal
/v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-operational:
post:
tags:
- dmi-plugin
summary: Get resource data from passthrough-operational for cm handle
description: Get resource data from passthrough-operational for cm handle. Will
support read operations only.
operationId: dataAccessPassthroughOperational
parameters:
- name: cmHandle
in: path
description: The identifier for a network function, network element, subnetwork,
or any other cm object by managed Network CM Proxy
required: true
schema:
type: string
- name: resourceIdentifier
in: query
description: Resource identifier to get/set the resource data
required: true
allowReserved: true
schema:
type: string
- name: accept
in: header
description: Accept parameter for response, if accept parameter is null, that
means client can accept any format.
schema:
type: string
enum:
- application/json
- application/yang-data+json
- name: options
in: query
description: options parameter in query, it is mandatory to wrap key(s)=value(s)
in parenthesis'()'.
required: false
allowReserved: true
schema:
type: string
examples:
sample1:
value:
options: (key1=value1,key2=value2)
sample2:
value:
options: (key1=value1,key2=value1/value2)
sample3:
value:
options: (key1=10,key2=value2,key3=[val31,val32])
requestBody:
description: Operational body
content:
application/json:
schema:
$ref: '#/components/schemas/DataAccessRequest'
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/ch/{cmHandle}/data/ds/ncmp-datastore:passthrough-running:
post:
tags:
- dmi-plugin
summary: Get, Create or Update request for data passthrough-running for a cm-handle
description: Post request to Get, Create or to Update resource data for a cm-handle.
Since all requests need to include additional information in a request body
HTTP Post is used for all use cases and the actual operation is defined in
the request body instead.
operationId: dataAccessPassthroughRunning
parameters:
- name: cmHandle
in: path
description: The identifier for a network function, network element, subnetwork,
or any other cm object by managed Network CM Proxy
required: true
schema:
type: string
- name: resourceIdentifier
in: query
description: Resource identifier to get/set the resource data
required: true
allowReserved: true
schema:
type: string
- name: accept
in: header
description: Accept parameter for response, if accept parameter is null, that
means client can accept any format.
schema:
type: string
enum:
- application/json
- application/yang-data+json
- name: options
in: query
description: options parameter in query, it is mandatory to wrap key(s)=value(s)
in parenthesis'()'.
required: false
allowReserved: true
schema:
type: string
examples:
sample1:
value:
options: (key1=value1,key2=value2)
sample2:
value:
options: (key1=value1,key2=value1/value2)
sample3:
value:
options: (key1=10,key2=value2,key3=[val31,val32])
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DataAccessRequest'
responses:
"201":
description: Created
content:
text/plain:
schema:
type: string
"400":
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
"403":
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
components:
schemas:
ModuleReferencesRequest:
type: object
properties:
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
cmHandleProperties:
type: object
additionalProperties:
type: string
example: '{"prop1":"value1","prop2":"value2"}'
ModuleSet:
type: object
properties:
schemas:
type: array
items:
$ref: '#/components/schemas/ModuleSet_schemas'
revision:
type: string
example: someRevision
ErrorMessage:
title: Error
type: object
properties:
status:
type: string
message:
type: string
details:
type: string
ModuleResourcesReadRequest:
type: object
properties:
data:
$ref: '#/components/schemas/ModuleResourcesReadRequest_data'
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
name:
type: string
example: someName
YangResources:
type: array
items:
$ref: '#/components/schemas/YangResource'
YangResource:
properties:
yangSource:
type: string
moduleName:
type: string
revision:
$ref: '#/components/schemas/revision'
CmHandles:
type: object
properties:
cmHandles:
type: array
items:
type: string
DataAccessRequest:
type: object
properties:
operation:
type: string
enum:
- read
- create
- update
- delete
dataType:
type: string
data:
type: string
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
ModuleSet_schemas:
type: object
properties:
moduleName:
type: string
revision:
$ref: '#/components/schemas/revision'
namespace:
type: string
ModuleResourcesReadRequest_data_modules:
type: object
properties:
name:
$ref: '#/components/schemas/name'
revision:
$ref: '#/components/schemas/revision'
ModuleResourcesReadRequest_data:
type: object
properties:
modules:
type: array
items:
$ref: '#/components/schemas/ModuleResourcesReadRequest_data_modules'
|
