1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021-2022 Nordix Foundation
3 # Modifications Copyright (C) 2021 Pantheon.tech
4 # Modifications Copyright (C) 2021 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/acceptParamInHeader'
31 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
32 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
42 $ref: 'components.yaml#/components/examples/dataSampleResponse'
44 $ref: 'components.yaml#/components/responses/BadRequest'
46 $ref: 'components.yaml#/components/responses/Unauthorized'
48 $ref: 'components.yaml#/components/responses/Forbidden'
50 $ref: 'components.yaml#/components/responses/InternalServerError'
52 $ref: 'components.yaml#/components/responses/BadGateway'
54 resourceDataForPassthroughRunning:
58 summary: Get resource data from pass-through running for cm handle
59 description: Get resource data from pass-through running for given cm handle
60 operationId: getResourceDataRunningForCmHandle
62 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
63 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
64 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
65 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
66 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
76 $ref: 'components.yaml#/components/examples/dataSampleResponse'
78 $ref: 'components.yaml#/components/responses/BadRequest'
80 $ref: 'components.yaml#/components/responses/Unauthorized'
82 $ref: 'components.yaml#/components/responses/Forbidden'
84 $ref: 'components.yaml#/components/responses/InternalServerError'
86 $ref: 'components.yaml#/components/responses/BadGateway'
90 summary: create resource data from pass-through running for cm handle
91 description: create resource data from pass-through running for given cm handle
92 operationId: createResourceDataRunningForCmHandle
94 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
95 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
96 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
105 $ref: 'components.yaml#/components/examples/dataSampleRequest'
106 application/yang-data+json:
111 $ref: 'components.yaml#/components/examples/dataSampleRequest'
114 $ref: 'components.yaml#/components/responses/Created'
116 $ref: 'components.yaml#/components/responses/BadRequest'
118 $ref: 'components.yaml#/components/responses/Unauthorized'
120 $ref: 'components.yaml#/components/responses/Forbidden'
122 $ref: 'components.yaml#/components/responses/InternalServerError'
124 $ref: 'components.yaml#/components/responses/BadGateway'
129 summary: Update resource data from pass-through running for a cm handle
130 description: Update resource data from pass-through running for the given cm handle
131 operationId: updateResourceDataRunningForCmHandle
133 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
134 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
135 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
144 $ref: 'components.yaml#/components/examples/dataSampleRequest'
145 application/yang-data+json:
150 $ref: 'components.yaml#/components/examples/dataSampleRequest'
153 $ref: 'components.yaml#/components/responses/Ok'
155 $ref: 'components.yaml#/components/responses/BadRequest'
157 $ref: 'components.yaml#/components/responses/Unauthorized'
159 $ref: 'components.yaml#/components/responses/Forbidden'
161 $ref: 'components.yaml#/components/responses/InternalServerError'
163 $ref: 'components.yaml#/components/responses/BadGateway'
168 summary: Patch resource data from pass-through running
169 description: Patch resource data from pass-through running for the given cm handle
170 operationId: patchResourceDataRunningForCmHandle
172 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
173 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
174 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
183 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
186 $ref: 'components.yaml#/components/responses/Ok'
188 $ref: 'components.yaml#/components/responses/BadRequest'
190 $ref: 'components.yaml#/components/responses/Unauthorized'
192 $ref: 'components.yaml#/components/responses/Forbidden'
194 $ref: 'components.yaml#/components/responses/InternalServerError'
196 $ref: 'components.yaml#/components/responses/BadGateway'
201 summary: Delete resource data
202 description: Delete resource data from pass-through running for a given cm handle
203 operationId: deleteResourceDataRunningForCmHandle
205 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
206 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
207 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
210 $ref: 'components.yaml#/components/responses/NoContent'
212 $ref: 'components.yaml#/components/responses/BadRequest'
214 $ref: 'components.yaml#/components/responses/Unauthorized'
216 $ref: 'components.yaml#/components/responses/Forbidden'
218 $ref: 'components.yaml#/components/responses/NotFound'
220 $ref: 'components.yaml#/components/responses/InternalServerError'
222 $ref: 'components.yaml#/components/responses/BadGateway'
224 fetchModuleReferencesByCmHandle:
226 description: fetch all module references (name and revision) for a given cm handle
229 summary: Fetch all module references (name and revision) for a given cm handle
230 operationId: getModuleReferencesByCmHandle
232 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
241 $ref: 'components.yaml#/components/schemas/RestModuleReference'
243 $ref: 'components.yaml#/components/responses/BadRequest'
245 $ref: 'components.yaml#/components/responses/Unauthorized'
247 $ref: 'components.yaml#/components/responses/Forbidden'
249 $ref: 'components.yaml#/components/responses/InternalServerError'
251 executeCmHandleSearch:
253 description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
256 summary: Execute cm handle search using the available conditions
257 operationId: executeCmHandleSearch
263 $ref: 'components.yaml#/components/schemas/Conditions'
270 $ref: 'components.yaml#/components/schemas/CmHandles'
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/BadRequest'
299 $ref: 'components.yaml#/components/responses/Unauthorized'
301 $ref: 'components.yaml#/components/responses/Forbidden'
303 $ref: 'components.yaml#/components/responses/NotFound'
305 $ref: 'components.yaml#/components/responses/InternalServerError'