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'
249 fetchModuleDefinitionsByCmHandle:
251 description: Fetch all module definitions (name, revision, yang resource) for a given cm handle
254 summary: Fetch all module definitions (name, revision, yang resource) for a given cm handle
255 operationId: getModuleDefinitionsByCmHandleId
257 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
266 $ref: 'components.yaml#/components/schemas/RestModuleDefinition'
268 $ref: 'components.yaml#/components/responses/Unauthorized'
270 $ref: 'components.yaml#/components/responses/Forbidden'
272 $ref: 'components.yaml#/components/responses/InternalServerError'
276 description: Execute cm handle query search and return a list of cm handle details. Any number of conditions can be applied. To be included in the result a cm-handle must fulfill ALL the conditions. An empty collection will be returned in the case that the cm handle does not match a condition. For more on cm handle query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible to query on any data related to the cm handle. For more on CPS Path please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS Path Read the Docs</a>. The cm handle ancestor is automatically returned for this query.
279 summary: Execute cm handle search using the available conditions
280 operationId: searchCmHandles
286 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
288 Cm handle properties query:
289 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
290 Cm handle modules query:
291 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
292 All cm handle query parameters:
293 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
294 Cm handle with CPS path state query:
295 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
296 Cm handle with data sync flag query:
297 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
306 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
308 $ref: 'components.yaml#/components/responses/BadRequest'
310 $ref: 'components.yaml#/components/responses/Unauthorized'
312 $ref: 'components.yaml#/components/responses/Forbidden'
314 $ref: 'components.yaml#/components/responses/InternalServerError'
316 retrieveCmHandleDetailsById:
318 description: Retrieve CM handle details and properties by cm handle id
321 summary: Retrieve CM handle details
322 operationId: retrieveCmHandleDetailsById
324 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
331 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
333 $ref: 'components.yaml#/components/responses/BadRequest'
335 $ref: 'components.yaml#/components/responses/Unauthorized'
337 $ref: 'components.yaml#/components/responses/NotFound'
339 $ref: 'components.yaml#/components/responses/InternalServerError'
341 getCmHandlePropertiesById:
343 description: Get CM handle properties by cm handle id
346 summary: Get CM handle properties
347 operationId: getCmHandlePublicPropertiesByCmHandleId
349 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
356 $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
358 $ref: 'components.yaml#/components/responses/BadRequest'
360 $ref: 'components.yaml#/components/responses/Unauthorized'
362 $ref: 'components.yaml#/components/responses/NotFound'
364 $ref: 'components.yaml#/components/responses/InternalServerError'
366 getCmHandleStateById:
368 description: Get CM handle state by cm handle id
371 summary: Get CM handle state
372 operationId: getCmHandleStateByCmHandleId
374 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
381 $ref: 'components.yaml#/components/schemas/RestOutputCmHandleCompositeState'
383 $ref: 'components.yaml#/components/responses/BadRequest'
385 $ref: 'components.yaml#/components/responses/Unauthorized'
387 $ref: 'components.yaml#/components/responses/NotFound'
389 $ref: 'components.yaml#/components/responses/InternalServerError'
393 description: Execute cm handle query search and return a list of cm handle ids. Any number of conditions can be applied. To be included in the result a cm-handle must fulfill ALL the conditions. An empty collection will be returned in the case that the cm handle does not match a condition. For more on cm handle query search please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/ncmp-cmhandle-querying.html">cm handle query search Read the Docs</a>.<br/>By supplying a CPS Path it is possible to query on any data related to the cm handle. For more on CPS Path please refer to <a href="https://docs.onap.org/projects/onap-cps/en/latest/cps-path.html">CPS Path Read the Docs</a>. The cm handle ancestor is automatically returned for this query.
396 summary: Execute cm handle query upon a given set of query parameters
397 operationId: searchCmHandleIds
403 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
405 Cm handle properties query:
406 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
407 Cm handle modules query:
408 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
409 All cm handle query parameters:
410 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
411 Cm handle with CPS path state query:
412 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
413 Cm handle with data sync flag query:
414 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
425 $ref: 'components.yaml#/components/responses/BadRequest'
427 $ref: 'components.yaml#/components/responses/Unauthorized'
429 $ref: 'components.yaml#/components/responses/Forbidden'
431 $ref: 'components.yaml#/components/responses/NotFound'
433 $ref: 'components.yaml#/components/responses/InternalServerError'
435 setDataSyncEnabledFlag:
439 summary: Set the Data Sync Enabled Flag
440 description: Set the data sync enabled flag to true or false for a specified Cm-Handle. This will in turn set the data sync state to UNSYNCHRONIZED and NONE_REQUESTED respectfully.
441 operationId: setDataSyncEnabledFlagForCmHandle
443 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
444 - $ref: 'components.yaml#/components/parameters/dataSyncEnabled'
447 $ref: 'components.yaml#/components/responses/Ok'
449 $ref: 'components.yaml#/components/responses/BadRequest'
451 $ref: 'components.yaml#/components/responses/Unauthorized'
453 $ref: 'components.yaml#/components/responses/Forbidden'
455 $ref: 'components.yaml#/components/responses/InternalServerError'
457 $ref: 'components.yaml#/components/responses/BadGateway'