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
|
# ============LICENSE_START=======================================================
# Copyright (C) 2021-2023 Nordix Foundation
# Modifications Copyright (C) 2022 Bell Canada
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# ============LICENSE_END=========================================================
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
schemas:
ErrorMessage:
type: object
title: Error
properties:
status:
type: string
message:
type: string
details:
type: string
CmHandles:
type: object
properties:
cmHandles:
type: array
example: ["cmHandleId1","cmHandleId2","cmHandleId3"]
items:
type: string
ModuleReferencesRequest:
type: object
properties:
moduleSetTag:
type: string
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
ResourceDataOperationRequests:
type: array
items:
type: object
title: 'DataOperationRequest'
properties:
operation:
type: string
example: 'read'
operationId:
description: 'it is recommended that the operationId is unique within the scope of the request'
type: string
example: '12'
datastore:
type: string
example: 'ncmp-datastore:passthrough-operational'
options:
type: string
example: 'some option'
resourceIdentifier:
type: string
example: 'some resource identifier'
cmHandles:
type: array
items:
$ref: '#/components/schemas/dmiOperationCmHandle'
required:
- operation
- operationId
- datastore
- cmHandles
dmiOperationCmHandle:
type: object
title: 'CmHandle with properties for DMI'
properties:
id:
type: string
cmHandleProperties:
additionalProperties:
type: string
moduleSetTag:
type: string
example: module-set-tag1
example:
id: cmHandle123
cmHandleProperties:
myProp: some value
otherProp: other value
moduleSetTag: module-set-tag1
ModuleResourcesReadRequest:
type: object
properties:
moduleSetTag:
type: string
description: Module set tag of the given cm handle
example: Module-set-tag-1
required: false
data:
type: object
properties:
modules:
type: array
items:
type: object
properties:
name:
type: string
example: my-name
revision:
type: string
example: my-revision
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
ModuleSet:
type: object
properties:
schemas:
type: array
items:
type: object
properties:
moduleName:
type: string
example: my-module-name
revision:
type: string
example: my-revision
namespace:
type: string
example: my-namespace
YangResources:
type: array
items:
$ref: '#/components/schemas/YangResource'
YangResource:
properties:
yangSource:
type: string
example: my-yang-source
moduleName:
type: string
example: my-module-name
revision:
type: string
example: my-revision
DataAccessRequest:
type: object
properties:
operation:
type: string
enum: [ read, create, update, patch, delete ]
example: read
dataType:
type: string
example: my-data-type
data:
type: string
example: my-data
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
requestId:
type: string
example: 3a9ce55c-e365-4dc9-8da3-a06f07cbc6d7
moduleSetTag:
type: string
example: module-set-tag1
cmHandleProperties:
type: object
nullable: true
additionalProperties:
type: string
example: {"prop1":"value1","prop2":"value2"}
responses:
NoContent:
description: No Content
content: {}
BadRequest:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 400
message: Bad Request
details: The provided request is not valid
NotFound:
description: The specified resource was not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 404
message: Resource Not Found
details: The requested resource is not found
ServerError:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 500
message: Internal Server Error
details: Internal Server Error occured
NotImplemented:
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessage'
example:
status: 501
message: Not Implemented
details: Method Not Implemented
parameters:
cmHandleInPath:
name: cmHandle
in: path
description: The CM handle or alternate identifier for a network function, network element, subnetwork, or any other CM object managed by Network CM Proxy
required: true
schema:
type: string
example: my-cm-handle
resourceIdentifierInQuery:
name: resourceIdentifier
in: query
description: Resource identifier to get/set the resource data
required: true
schema:
type: string
example: my-schema:my-node
optionsParamInQuery:
name: options
in: query
description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'.
required: false
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)
topicParamInQuery:
name: topic
in: query
description: topic name passed from client(NCMP).
required: false
schema:
type: string
examples:
sample1:
value: my-topic-name
requiredTopicParamInQuery:
name: topic
in: query
description: mandatory topic name passed from client(NCMP).
required: true
schema:
type: string
examples:
sample1:
value:
topic: my-topic-name
requiredRequestIdParamInQuery:
name: requestId
in: query
description: request ID generated by NCMP and is sent here and sent as an acknowledgement for the client request.
required: true
schema:
type: string
examples:
sample1:
value: 4753fc1f-7de2-449a-b306-a6204b5370b3
datastoreName:
name: datastore-name
in: path
description: The type of the requested data
required: true
schema:
type: string
example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running
security:
- basicAuth: []
|
