1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021-2022 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/RestCmHandleProperties'
71 publicCmHandleProperties:
72 $ref: '#/components/schemas/RestCmHandleProperties'
73 RestCmHandleProperties:
83 $ref: '#/components/schemas/ConditionsData'
88 $ref: '#/components/schemas/ConditionProperties'
93 example: hasAllModules
95 $ref: '#/components/schemas/ModuleNamesAsJsonArray'
96 ModuleNamesAsJsonArray:
100 $ref: '#/components/schemas/ModuleNameAsJsonObject'
101 example: [my-module-1, my-module-2, my-module-3]
102 ModuleNameAsJsonObject:
113 $ref: '#/components/schemas/CmHandleProperties'
118 $ref: '#/components/schemas/CmHandleProperty'
123 example: my-cm-handle-id
127 title: Module reference details
131 example: my-module-name
134 example: my-module-revision
138 summary: Sample request
139 description: Sample request body
142 bookstore-name: Chapters
156 dataSamplePatchRequest:
157 summary: Sample patch request
158 description: Sample patch request body
160 ietf-restconf:yang-patch:
168 bookstore-name: Chapters
186 bookstore-name: Novels
201 summary: Sample response
202 description: Sample response for selecting 'sample 1'.
222 description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
226 example: my-cm-handle
235 requiredXpathInQuery:
242 includeDescendantsOptionInQuery:
243 name: include-descendants
245 description: include-descendants
253 description: cps-path
258 resourceIdentifierInQuery:
259 name: resourceIdentifier
261 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.
269 resourceIdentifier: \shops\bookstore
272 resourceIdentifier: \shops\bookstore\categories[@code=1]
275 resourceIdentifier: parent=shops,child=bookstore
280 description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
283 enum: [ application/json, application/yang-data+json ]
287 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.
298 options: (fields=book)
301 options: (depth=2,fields=book/authors)
302 contentParamInHeader:
306 description: Content parameter for request, if content parameter is null, default value is application/json.
309 default: application/json
310 example: application/yang-data+json
314 description: The specified resource was not found
318 $ref: '#/components/schemas/ErrorMessage'
321 message: Not found error message
322 details: Not found error details
324 description: Unauthorized
328 $ref: '#/components/schemas/ErrorMessage'
331 message: Unauthorized error message
332 details: Unauthorized error details
334 description: Forbidden
338 $ref: '#/components/schemas/ErrorMessage'
341 message: Forbidden error message
342 details: Forbidden error details
344 description: Bad Request
348 $ref: '#/components/schemas/ErrorMessage'
350 status: 400 BAD_REQUEST
351 message: Bad request error message
352 details: Bad request error details
354 description: Conflict
358 $ref: '#/components/schemas/ErrorMessage'
361 message: Conflict error message
362 details: Conflict error details
364 description: The given path has not been implemented
368 $ref: '#/components/schemas/ErrorMessage'
371 message: Not implemented error message
372 details: Not implemented error details
383 description: No Content
386 description: Internal Server Error
390 $ref: "#/components/schemas/ErrorMessage"
393 message: Internal Server Error
394 details: Internal Server Error occurred