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'
54 $ref: '#/components/schemas/RestCmHandle'
59 example: [my-cm-handle1, my-cm-handle2, my-cm-handle3]
70 $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
71 RestCmHandleAdditionalProperties:
75 example: my-additional-property
81 $ref: '#/components/schemas/ConditionsData'
86 $ref: '#/components/schemas/ConditionProperties'
91 example: hasAllModules
93 $ref: '#/components/schemas/ModuleNamesAsJsonArray'
94 ModuleNamesAsJsonArray:
98 $ref: '#/components/schemas/ModuleNameAsJsonObject'
99 example: [my-module-1, my-module-2, my-module-3]
100 ModuleNameAsJsonObject:
111 $ref: '#/components/schemas/CmHandleProperties'
116 $ref: '#/components/schemas/CmHandleProperty'
121 example: my-cm-handle-id
125 title: Module reference details
129 example: my-module-name
132 example: my-module-revision
136 summary: Sample request
137 description: Sample request body
140 bookstore-name: Chapters
155 summary: Sample response
156 description: Sample response for selecting 'sample 1'.
176 description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
180 example: my-cm-handle
189 requiredXpathInQuery:
196 includeDescendantsOptionInQuery:
197 name: include-descendants
199 description: include-descendants
207 description: cps-path
212 resourceIdentifierInQuery:
213 name: resourceIdentifier
215 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.
223 resourceIdentifier: \shops\bookstore
226 resourceIdentifier: \shops\bookstore\categories[@code=1]
229 resourceIdentifier: parent=shops,child=bookstore
234 description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
237 enum: [ application/json, application/yang-data+json ]
241 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.
252 options: (fields=book)
255 options: (depth=2,fields=book/authors)
256 contentParamInHeader:
260 description: Content parameter for request, if content parameter is null, default value is application/json.
263 default: application/json
264 example: application/yang-data+json
268 description: The specified resource was not found
272 $ref: '#/components/schemas/ErrorMessage'
275 message: Not found error message
276 details: Not found error details
278 description: Unauthorized
282 $ref: '#/components/schemas/ErrorMessage'
285 message: Unauthorized error message
286 details: Unauthorized error details
288 description: Forbidden
292 $ref: '#/components/schemas/ErrorMessage'
295 message: Forbidden error message
296 details: Forbidden error details
298 description: Bad Request
302 $ref: '#/components/schemas/ErrorMessage'
304 status: 400 BAD_REQUEST
305 message: Bad request error message
306 details: Bad request error details
308 description: Conflict
312 $ref: '#/components/schemas/ErrorMessage'
315 message: Conflict error message
316 details: Conflict error details
318 description: The given path has not been implemented
322 $ref: '#/components/schemas/ErrorMessage'
325 message: Not implemented error message
326 details: Not implemented error details
337 description: No Content