1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021-2023 Nordix Foundation
3 # Modifications Copyright (C) 2022 Bell Canada
4 # ================================================================================
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # SPDX-License-Identifier: Apache-2.0
18 # ============LICENSE_END=========================================================
42 example: ["cmHandleId1","cmHandleId2","cmHandleId3"]
46 ModuleReferencesRequest:
52 $ref: '#/components/schemas/cmHandleProperties'
54 ResourceDataOperationRequests:
58 title: 'DataOperationRequest'
64 description: 'it is recommended that the operationId is unique within the scope of the request'
69 example: 'ncmp-datastore:passthrough-operational'
72 example: 'some option'
75 example: 'some resource identifier'
79 $ref: '#/components/schemas/dmiOperationCmHandle'
88 title: 'CmHandle with properties for DMI'
97 example: module-set-tag1
102 otherProp: other value
103 moduleSetTag: module-set-tag1
105 ModuleResourcesReadRequest:
110 description: Module set tag of the given cm handle
111 example: Module-set-tag-1
128 $ref: '#/components/schemas/cmHandleProperties'
140 example: my-module-name
146 example: my-namespace
151 $ref: '#/components/schemas/YangResource'
157 example: my-yang-source
160 example: my-module-name
170 enum: [ read, create, update, patch, delete ]
174 example: my-data-type
179 $ref: '#/components/schemas/cmHandleProperties'
182 example: 3a9ce55c-e365-4dc9-8da3-a06f07cbc6d7
185 example: module-set-tag1
190 additionalProperties:
192 example: {"prop1":"value1","prop2":"value2"}
196 description: No Content
200 description: Bad Request
204 $ref: '#/components/schemas/ErrorMessage'
208 details: The provided request is not valid
211 description: The specified resource was not found
215 $ref: '#/components/schemas/ErrorMessage'
218 message: Resource Not Found
219 details: The requested resource is not found
222 description: Internal Server Error
226 $ref: '#/components/schemas/ErrorMessage'
229 message: Internal Server Error
230 details: Internal Server Error occured
233 description: Not Implemented
237 $ref: '#/components/schemas/ErrorMessage'
240 message: Not Implemented
241 details: Method Not Implemented
247 description: The identifier for a network function, network element, subnetwork, or any other cm object by managed Network CM Proxy
251 example: my-cm-handle
253 resourceIdentifierInQuery:
254 name: resourceIdentifier
256 description: Resource identifier to get/set the resource data
260 example: my-schema:my-node
265 description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'.
272 options: (key1=value1,key2=value2)
275 options: (key1=value1,key2=value1/value2)
278 options: (key1=10,key2=value2,key3=val31,val32)
283 description: topic name passed from client(NCMP).
291 requiredTopicParamInQuery:
294 description: mandatory topic name passed from client(NCMP).
303 requiredRequestIdParamInQuery:
306 description: request Id generated by NCMP and sent as an acknowledgement for the client request the same including here.
312 value: 4753fc1f-7de2-449a-b306-a6204b5370b3
317 description: The type of the requested data
321 example: ncmp-datastore:passthrough-operational or ncmp-datastore:passthrough-running