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 resourceDataForPassthroughRunning:
56 summary: Get resource data from pass-through running for cm handle
57 description: Get resource data from pass-through running for given cm handle
58 operationId: getResourceDataRunningForCmHandle
60 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
61 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
62 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
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'
86 summary: create resource data from pass-through running for cm handle
87 description: create resource data from pass-through running for given cm handle
88 operationId: createResourceDataRunningForCmHandle
90 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
91 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
92 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
101 $ref: 'components.yaml#/components/examples/dataSampleRequest'
102 application/yang-data+json:
107 $ref: 'components.yaml#/components/examples/dataSampleRequest'
110 $ref: 'components.yaml#/components/responses/Created'
112 $ref: 'components.yaml#/components/responses/BadRequest'
114 $ref: 'components.yaml#/components/responses/Unauthorized'
116 $ref: 'components.yaml#/components/responses/Forbidden'
118 $ref: 'components.yaml#/components/responses/InternalServerError'
123 summary: Update resource data from pass-through running for a cm handle
124 description: Update resource data from pass-through running for the given cm handle
125 operationId: updateResourceDataRunningForCmHandle
127 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
128 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
129 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
138 $ref: 'components.yaml#/components/examples/dataSampleRequest'
139 application/yang-data+json:
144 $ref: 'components.yaml#/components/examples/dataSampleRequest'
147 $ref: 'components.yaml#/components/responses/Ok'
149 $ref: 'components.yaml#/components/responses/BadRequest'
151 $ref: 'components.yaml#/components/responses/Unauthorized'
153 $ref: 'components.yaml#/components/responses/Forbidden'
155 $ref: 'components.yaml#/components/responses/InternalServerError'
160 summary: Patch resource data from pass-through running
161 description: Patch resource data from pass-through running for the given cm handle
162 operationId: patchResourceDataRunningForCmHandle
164 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
165 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
166 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
175 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
178 $ref: 'components.yaml#/components/responses/Ok'
180 $ref: 'components.yaml#/components/responses/BadRequest'
182 $ref: 'components.yaml#/components/responses/Unauthorized'
184 $ref: 'components.yaml#/components/responses/Forbidden'
186 $ref: 'components.yaml#/components/responses/InternalServerError'
191 summary: Delete resource data
192 description: Delete resource data from pass-through running for a given cm handle
193 operationId: deleteResourceDataRunningForCmHandle
195 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
196 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
197 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
200 $ref: 'components.yaml#/components/responses/NoContent'
202 $ref: 'components.yaml#/components/responses/BadRequest'
204 $ref: 'components.yaml#/components/responses/Unauthorized'
206 $ref: 'components.yaml#/components/responses/Forbidden'
208 $ref: 'components.yaml#/components/responses/NotFound'
210 $ref: 'components.yaml#/components/responses/InternalServerError'
212 fetchModuleReferencesByCmHandle:
214 description: fetch all module references (name and revision) for a given cm handle
217 summary: Fetch all module references (name and revision) for a given cm handle
218 operationId: getModuleReferencesByCmHandle
220 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
229 $ref: 'components.yaml#/components/schemas/ModuleReference'
231 $ref: 'components.yaml#/components/responses/BadRequest'
233 $ref: 'components.yaml#/components/responses/Unauthorized'
235 $ref: 'components.yaml#/components/responses/Forbidden'
237 $ref: 'components.yaml#/components/responses/InternalServerError'
239 executeCmHandleSearch:
241 description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
244 summary: Execute cm handle search using the available conditions
245 operationId: executeCmHandleSearch
251 $ref: 'components.yaml#/components/schemas/Conditions'
258 $ref: 'components.yaml#/components/schemas/CmHandles'
260 $ref: 'components.yaml#/components/responses/BadRequest'
262 $ref: 'components.yaml#/components/responses/Unauthorized'
264 $ref: 'components.yaml#/components/responses/Forbidden'
266 $ref: 'components.yaml#/components/responses/InternalServerError'
268 retrieveCmHandleDetailsById:
270 description: Retrieve CM handle details and properties by cm handle id
273 summary: Retrieve CM handle details
274 operationId: retrieveCmHandleDetailsById
276 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
283 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
285 $ref: 'components.yaml#/components/responses/BadRequest'
287 $ref: 'components.yaml#/components/responses/Unauthorized'
289 $ref: 'components.yaml#/components/responses/Forbidden'
291 $ref: 'components.yaml#/components/responses/NotFound'
293 $ref: 'components.yaml#/components/responses/InternalServerError'