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'
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/NotFound'
51 resourceDataForPassthroughRunning:
55 summary: Get resource data from pass-through running for cm handle
56 description: Get resource data from pass-through running for given cm handle
57 operationId: getResourceDataRunningForCmHandle
59 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
60 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
61 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
62 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
72 $ref: 'components.yaml#/components/examples/dataSampleResponse'
74 $ref: 'components.yaml#/components/responses/BadRequest'
76 $ref: 'components.yaml#/components/responses/Unauthorized'
78 $ref: 'components.yaml#/components/responses/Forbidden'
80 $ref: 'components.yaml#/components/responses/NotFound'
84 summary: create resource data from pass-through running for cm handle
85 description: create resource data from pass-through running for given cm handle
86 operationId: createResourceDataRunningForCmHandle
88 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
89 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
90 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
99 $ref: 'components.yaml#/components/examples/dataSampleRequest'
100 application/yang-data+json:
105 $ref: 'components.yaml#/components/examples/dataSampleRequest'
108 $ref: 'components.yaml#/components/responses/Created'
110 $ref: 'components.yaml#/components/responses/BadRequest'
112 $ref: 'components.yaml#/components/responses/Unauthorized'
114 $ref: 'components.yaml#/components/responses/Forbidden'
116 $ref: 'components.yaml#/components/responses/NotFound'
121 summary: Update resource data from pass-through running for a cm handle
122 description: Update resource data from pass-through running for the given cm handle
123 operationId: updateResourceDataRunningForCmHandle
125 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
126 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
127 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
136 $ref: 'components.yaml#/components/examples/dataSampleRequest'
137 application/yang-data+json:
142 $ref: 'components.yaml#/components/examples/dataSampleRequest'
145 $ref: 'components.yaml#/components/responses/Ok'
147 $ref: 'components.yaml#/components/responses/BadRequest'
149 $ref: 'components.yaml#/components/responses/Unauthorized'
151 $ref: 'components.yaml#/components/responses/Forbidden'
153 $ref: 'components.yaml#/components/responses/NotFound'
158 summary: Patch resource data from pass-through running
159 description: Patch resource data from pass-through running for the given cm handle
160 operationId: patchResourceDataRunningForCmHandle
162 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
163 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
164 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
173 $ref: 'components.yaml#/components/examples/dataSampleRequest'
176 $ref: 'components.yaml#/components/responses/Ok'
178 $ref: 'components.yaml#/components/responses/BadRequest'
180 $ref: 'components.yaml#/components/responses/Unauthorized'
182 $ref: 'components.yaml#/components/responses/Forbidden'
184 $ref: 'components.yaml#/components/responses/NotFound'
189 summary: Delete resource data
190 description: Delete resource data from pass-through running for a given cm handle
191 operationId: deleteResourceDataRunningForCmHandle
193 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
194 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
195 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
198 $ref: 'components.yaml#/components/responses/NoContent'
200 $ref: 'components.yaml#/components/responses/BadRequest'
202 $ref: 'components.yaml#/components/responses/Unauthorized'
204 $ref: 'components.yaml#/components/responses/Forbidden'
206 $ref: 'components.yaml#/components/responses/NotFound'
209 fetchModuleReferencesByCmHandle:
211 description: fetch all module references (name and revision) for a given cm handle
214 summary: Fetch all module references (name and revision) for a given cm handle
215 operationId: getModuleReferencesByCmHandle
217 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
226 $ref: 'components.yaml#/components/schemas/ModuleReference'
228 $ref: 'components.yaml#/components/responses/BadRequest'
230 $ref: 'components.yaml#/components/responses/Unauthorized'
232 $ref: 'components.yaml#/components/responses/Forbidden'
234 $ref: 'components.yaml#/components/responses/NotFound'
236 executeCmHandleSearch:
238 description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
241 summary: Execute cm handle search using the available conditions
242 operationId: executeCmHandleSearch
248 $ref: 'components.yaml#/components/schemas/Conditions'
255 $ref: 'components.yaml#/components/schemas/CmHandles'
257 $ref: 'components.yaml#/components/responses/BadRequest'
259 $ref: 'components.yaml#/components/responses/Unauthorized'
261 $ref: 'components.yaml#/components/responses/Forbidden'