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=========================================================
33 RestDmiPluginRegistration:
38 example: onap-dmi-plugin
42 $ref: '#/components/schemas/RestCmHandle'
46 $ref: '#/components/schemas/RestCmHandle'
61 $ref: '#/components/schemas/RestCmHandleAdditionalProperties'
62 RestCmHandleAdditionalProperties:
72 description: The identifier for a network function, network element, subnetwork or any other cm object by managed Network CM Proxy
91 includeDescendantsOptionInQuery:
92 name: include-descendants
94 description: include-descendants
102 description: cps-path
107 resourceIdentifierInQuery:
108 name: resourceIdentifier
110 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.
118 resourceIdentifier: \parent\child
121 resourceIdentifier: \parent\listElement[key=value]
124 resourceIdentifier: \parent\listElement[key=value]\grandChild
127 resourceIdentifier: parent=1,child=abc
132 description: Accept parameter for response, if accept parameter is null, that means client can accept any format.
135 enum: [ application/json, application/yang-data+json ]
139 description: options parameter in query, it is mandatory to wrap key(s)=value(s) in parenthesis'()'.
147 options: (key1=value1,key2=value2)
150 options: (key1=value1,key2=value1/value2)
153 options: (key1=10,key2=value2,key3=[val31;val32])
154 contentParamInHeader:
158 description: Content parameter for request, if content parameter is null, default value is application/json.
161 default: application/json
166 description: The specified resource was not found
170 $ref: '#/components/schemas/ErrorMessage'
172 description: Unauthorized
176 $ref: '#/components/schemas/ErrorMessage'
178 description: Forbidden
182 $ref: '#/components/schemas/ErrorMessage'
184 description: Bad Request
188 $ref: '#/components/schemas/ErrorMessage'
190 description: Conflict
194 $ref: '#/components/schemas/ErrorMessage'
196 description: The given path has not been implemented
200 $ref: '#/components/schemas/ErrorMessage'
211 description: No Content