1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021 Nordix Foundation
3 # Modifications Copyright (C) 2021 Pantheon.tech
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=========================================================
35 RestDmiPluginRegistration:
40 example: my-dmi-plugin
43 example: my-dmi-data-plugin
46 example: my-dmi-model-plugin
50 $ref: '#/components/schemas/RestCmHandle'
51 example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
55 $ref: '#/components/schemas/RestCmHandle'
60 example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
71 $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
72 RestCmHandleAdditionalProperties:
76 example: my-additional-property
82 $ref: '#/components/schemas/ConditionsData'
87 $ref: '#/components/schemas/ConditionProperties'
92 example: hasAllModules
94 $ref: '#/components/schemas/ModuleNamesAsJsonArray'
95 ModuleNamesAsJsonArray:
99 $ref: '#/components/schemas/ModuleNameAsJsonObject'
100 example: [my-module-1, my-module-2, my-module-3]
101 ModuleNameAsJsonObject:
112 $ref: '#/components/schemas/CmHandleProperties'
117 $ref: '#/components/schemas/CmHandleProperty'
122 example: my-cm-handle-id
126 summary: Sample request
127 description: Sample request body
130 bookstore-name: Chapters
146 summary: Sample response
147 description: Sample response for selecting 'sample 1'.
160 bookstore-name: Chapters
166 description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
170 example: my-cm-handle
179 requiredXpathInQuery:
186 includeDescendantsOptionInQuery:
187 name: include-descendants
189 description: include-descendants
197 description: cps-path
202 resourceIdentifierInQuery:
203 name: resourceIdentifier
205 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.
213 resourceIdentifier: \shops\bookstore
216 resourceIdentifier: \shops\bookstore\categories[@code=1]
219 resourceIdentifier: parent=shops,child=bookstore
224 description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
227 enum: [ application/json, application/yang-data+json ]
231 description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'. The format of options parameter depend on the associated DMI Plugin implementation.
242 options: (fields=book)
245 options: (depth=2,fields=book/authors)
246 contentParamInHeader:
250 description: Content parameter for request, if content parameter is null, default value is application/json.
253 default: application/json
254 example: application/yang-data+json
258 description: The specified resource was not found
262 $ref: '#/components/schemas/ErrorMessage'
265 message: Not found error message
266 details: Not found error details
268 description: Unauthorized
272 $ref: '#/components/schemas/ErrorMessage'
275 message: Unauthorized error message
276 details: Unauthorized error details
278 description: Forbidden
282 $ref: '#/components/schemas/ErrorMessage'
285 message: Forbidden error message
286 details: Forbidden error details
288 description: Bad Request
292 $ref: '#/components/schemas/ErrorMessage'
294 status: 400 BAD_REQUEST
295 message: Bad request error message
296 details: Bad request error details
298 description: Conflict
302 $ref: '#/components/schemas/ErrorMessage'
305 message: Conflict error message
306 details: Conflict error details
308 description: The given path has not been implemented
312 $ref: '#/components/schemas/ErrorMessage'
315 message: Not implemented error message
316 details: Not implemented error details
327 description: No Content