1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021-2022 Nordix Foundation
3 # Modifications Copyright (C) 2021 Pantheon.tech
4 # Modifications Copyright (C) 2021-2022 Bell Canada
5 # ================================================================================
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
18 # SPDX-License-Identifier: Apache-2.0
19 # ============LICENSE_END=========================================================
20 getResourceDataForPassthroughOperational:
24 summary: Get resource data from pass-through operational for cm handle
25 description: Get resource data from pass-through operational for given cm handle
26 operationId: getResourceDataOperationalForCmHandle
28 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
29 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
30 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
31 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
41 $ref: 'components.yaml#/components/examples/dataSampleResponse'
43 $ref: 'components.yaml#/components/responses/BadRequest'
45 $ref: 'components.yaml#/components/responses/Unauthorized'
47 $ref: 'components.yaml#/components/responses/Forbidden'
49 $ref: 'components.yaml#/components/responses/InternalServerError'
51 $ref: 'components.yaml#/components/responses/BadGateway'
53 resourceDataForPassthroughRunning:
57 summary: Get resource data from pass-through running for cm handle
58 description: Get resource data from pass-through running for given cm handle
59 operationId: getResourceDataRunningForCmHandle
61 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
62 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
63 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
64 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
74 $ref: 'components.yaml#/components/examples/dataSampleResponse'
76 $ref: 'components.yaml#/components/responses/BadRequest'
78 $ref: 'components.yaml#/components/responses/Unauthorized'
80 $ref: 'components.yaml#/components/responses/Forbidden'
82 $ref: 'components.yaml#/components/responses/InternalServerError'
84 $ref: 'components.yaml#/components/responses/BadGateway'
88 summary: create resource data from pass-through running for cm handle
89 description: create resource data from pass-through running for given cm handle
90 operationId: createResourceDataRunningForCmHandle
92 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
93 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
94 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
103 $ref: 'components.yaml#/components/examples/dataSampleRequest'
104 application/yang-data+json:
109 $ref: 'components.yaml#/components/examples/dataSampleRequest'
112 $ref: 'components.yaml#/components/responses/Created'
114 $ref: 'components.yaml#/components/responses/BadRequest'
116 $ref: 'components.yaml#/components/responses/Unauthorized'
118 $ref: 'components.yaml#/components/responses/Forbidden'
120 $ref: 'components.yaml#/components/responses/InternalServerError'
122 $ref: 'components.yaml#/components/responses/BadGateway'
127 summary: Update resource data from pass-through running for a cm handle
128 description: Update resource data from pass-through running for the given cm handle
129 operationId: updateResourceDataRunningForCmHandle
131 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
132 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
133 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
142 $ref: 'components.yaml#/components/examples/dataSampleRequest'
143 application/yang-data+json:
148 $ref: 'components.yaml#/components/examples/dataSampleRequest'
151 $ref: 'components.yaml#/components/responses/Ok'
153 $ref: 'components.yaml#/components/responses/BadRequest'
155 $ref: 'components.yaml#/components/responses/Unauthorized'
157 $ref: 'components.yaml#/components/responses/Forbidden'
159 $ref: 'components.yaml#/components/responses/InternalServerError'
161 $ref: 'components.yaml#/components/responses/BadGateway'
166 summary: Patch resource data from pass-through running
167 description: Patch resource data from pass-through running for the given cm handle
168 operationId: patchResourceDataRunningForCmHandle
170 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
171 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
172 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
181 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
184 $ref: 'components.yaml#/components/responses/Ok'
186 $ref: 'components.yaml#/components/responses/BadRequest'
188 $ref: 'components.yaml#/components/responses/Unauthorized'
190 $ref: 'components.yaml#/components/responses/Forbidden'
192 $ref: 'components.yaml#/components/responses/InternalServerError'
194 $ref: 'components.yaml#/components/responses/BadGateway'
199 summary: Delete resource data
200 description: Delete resource data from pass-through running for a given cm handle
201 operationId: deleteResourceDataRunningForCmHandle
203 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
204 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
205 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
208 $ref: 'components.yaml#/components/responses/NoContent'
210 $ref: 'components.yaml#/components/responses/BadRequest'
212 $ref: 'components.yaml#/components/responses/Unauthorized'
214 $ref: 'components.yaml#/components/responses/Forbidden'
216 $ref: 'components.yaml#/components/responses/NotFound'
218 $ref: 'components.yaml#/components/responses/InternalServerError'
220 $ref: 'components.yaml#/components/responses/BadGateway'
222 fetchModuleReferencesByCmHandle:
224 description: fetch all module references (name and revision) for a given cm handle
227 summary: Fetch all module references (name and revision) for a given cm handle
228 operationId: getModuleReferencesByCmHandle
230 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
239 $ref: 'components.yaml#/components/schemas/RestModuleReference'
241 $ref: 'components.yaml#/components/responses/BadRequest'
243 $ref: 'components.yaml#/components/responses/Unauthorized'
245 $ref: 'components.yaml#/components/responses/Forbidden'
247 $ref: 'components.yaml#/components/responses/InternalServerError'
251 description: Execute cm handle query search, to be included in the result a cm-handle must fulfill ALL the conditions listed here, if one of the given module names does not exists, return with an empty collection.
254 summary: Execute cm handle search using the available conditions
255 operationId: searchCmHandles
261 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
270 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
272 $ref: 'components.yaml#/components/responses/BadRequest'
274 $ref: 'components.yaml#/components/responses/Unauthorized'
276 $ref: 'components.yaml#/components/responses/Forbidden'
278 $ref: 'components.yaml#/components/responses/InternalServerError'
280 retrieveCmHandleDetailsById:
282 description: Retrieve CM handle details and properties by cm handle id
285 summary: Retrieve CM handle details
286 operationId: retrieveCmHandleDetailsById
288 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
295 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
297 $ref: 'components.yaml#/components/responses/NotFound'
299 $ref: 'components.yaml#/components/responses/InternalServerError'
301 getCmHandlePropertiesById:
303 description: Get CM handle properties by cm handle id
306 summary: Get CM handle properties
307 operationId: getCmHandlePublicPropertiesByCmHandleId
309 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
316 $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
318 $ref: 'components.yaml#/components/responses/NotFound'
320 $ref: 'components.yaml#/components/responses/InternalServerError'
324 description: Execute cm handle query search, to be included in the result a cm-handle must fulfill ALL the conditions listed here, if one of the given module names does not exists, return with an empty collection.
327 summary: Execute cm handle query upon a given set of query parameters
328 operationId: searchCmHandleIds
334 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
345 $ref: 'components.yaml#/components/responses/BadRequest'
347 $ref: 'components.yaml#/components/responses/Unauthorized'
349 $ref: 'components.yaml#/components/responses/Forbidden'
351 $ref: 'components.yaml#/components/responses/NotFound'
353 $ref: 'components.yaml#/components/responses/InternalServerError'