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
|
openapi: 3.0.1
info:
title: NCMP to CPS Proxy API
description: NCMP to CPS Proxy API
version: "1.0"
servers:
- url: /ncmp
paths:
/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-operational:
get:
tags:
- network-cm-proxy
summary: Get resource data from pass-through operational for cm handle
description: Get resource data from pass-through operational for given cm handle
operationId: getResourceDataOperationalForCmHandle
parameters:
- name: cm-handle
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: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
required: true
allowReserved: true
schema:
type: string
examples:
sample1:
value:
resourceIdentifier: \parent\child
sample2:
value:
resourceIdentifier: "\\parent\\listElement[key=value]"
sample3:
value:
resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
sample4:
value:
resourceIdentifier: "parent=1,child=abc"
- name: Accept
in: header
description: "Accept parameter for response, if accept parameter is null,\
\ that means client can accept any format."
required: false
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])"
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'
"404":
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/ch/{cm-handle}/data/ds/ncmp-datastore:passthrough-running:
get:
tags:
- network-cm-proxy
summary: Get resource data from pass-through running for cm handle
description: Get resource data from pass-through running for given cm handle
operationId: getResourceDataRunningForCmHandle
parameters:
- name: cm-handle
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: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
required: true
allowReserved: true
schema:
type: string
examples:
sample1:
value:
resourceIdentifier: \parent\child
sample2:
value:
resourceIdentifier: "\\parent\\listElement[key=value]"
sample3:
value:
resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
sample4:
value:
resourceIdentifier: "parent=1,child=abc"
- name: Accept
in: header
description: "Accept parameter for response, if accept parameter is null,\
\ that means client can accept any format."
required: false
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])"
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'
"404":
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
post:
tags:
- network-cm-proxy
summary: create resource data from pass-through running for cm handle
description: create resource data from pass-through running for given cm handle
operationId: createResourceDataRunningForCmHandle
parameters:
- name: cm-handle
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: The format of resource identifier depend on the associated DMI
Plugin implementation. For ONAP DMI Plugin it will be RESTConf paths but
it can really be anything.
required: true
allowReserved: true
schema:
type: string
examples:
sample1:
value:
resourceIdentifier: \parent\child
sample2:
value:
resourceIdentifier: "\\parent\\listElement[key=value]"
sample3:
value:
resourceIdentifier: "\\parent\\listElement[key=value]\\grandChild"
sample4:
value:
resourceIdentifier: "parent=1,child=abc"
- name: Content-Type
in: header
description: "Content parameter for request, if content parameter is null,\
\ default value is application/json."
required: false
schema:
type: string
default: application/json
requestBody:
content:
application/json:
schema:
type: string
application/yang-data+json:
schema:
type: string
required: true
responses:
"201":
description: Created
content: {}
"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'
"404":
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
/v1/ch/{cm-handle}/modules:
get:
tags:
- network-cm-proxy
summary: Fetch all module references (name and revision) for a given cm handle
description: fetch all module references (name and revision) for a given cm
handle
operationId: getModuleReferencesByCmHandle
parameters:
- name: cm-handle
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
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'
"404":
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
components:
schemas:
ErrorMessage:
title: Error
type: object
properties:
status:
type: string
message:
type: string
details:
type: string
|
