1 # ============LICENSE_START=======================================================
2 # Copyright (C) 2021-2023 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=========================================================
21 resourceDataForCmHandle:
25 summary: Get resource data for cm handle
26 description: Get resource data for given cm handle
27 operationId: getResourceDataForCmHandle
29 - $ref: 'components.yaml#/components/parameters/datastoreName'
30 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
31 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
32 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
33 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
34 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
44 $ref: 'components.yaml#/components/examples/dataSampleResponse'
46 $ref: 'components.yaml#/components/responses/BadRequest'
48 $ref: 'components.yaml#/components/responses/Unauthorized'
50 $ref: 'components.yaml#/components/responses/Forbidden'
52 $ref: 'components.yaml#/components/responses/InternalServerError'
54 $ref: 'components.yaml#/components/responses/BadGateway'
59 summary: create resource data from pass-through running for cm handle
60 description: create resource data from pass-through running for given cm handle
61 operationId: createResourceDataRunningForCmHandle
63 - $ref: 'components.yaml#/components/parameters/datastoreName'
64 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
65 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
66 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
75 $ref: 'components.yaml#/components/examples/dataSampleRequest'
76 application/yang-data+json:
81 $ref: 'components.yaml#/components/examples/dataSampleRequest'
84 $ref: 'components.yaml#/components/responses/Created'
86 $ref: 'components.yaml#/components/responses/BadRequest'
88 $ref: 'components.yaml#/components/responses/Unauthorized'
90 $ref: 'components.yaml#/components/responses/Forbidden'
92 $ref: 'components.yaml#/components/responses/InternalServerError'
94 $ref: 'components.yaml#/components/responses/BadGateway'
99 summary: Update resource data from pass-through running for a cm handle
100 description: Update resource data from pass-through running for the given cm handle
101 operationId: updateResourceDataRunningForCmHandle
103 - $ref: 'components.yaml#/components/parameters/datastoreName'
104 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
105 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
106 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
115 $ref: 'components.yaml#/components/examples/dataSampleRequest'
116 application/yang-data+json:
121 $ref: 'components.yaml#/components/examples/dataSampleRequest'
124 $ref: 'components.yaml#/components/responses/Ok'
126 $ref: 'components.yaml#/components/responses/BadRequest'
128 $ref: 'components.yaml#/components/responses/Unauthorized'
130 $ref: 'components.yaml#/components/responses/Forbidden'
132 $ref: 'components.yaml#/components/responses/InternalServerError'
134 $ref: 'components.yaml#/components/responses/BadGateway'
139 summary: Patch resource data from pass-through running
140 description: Patch resource data from pass-through running for the given cm handle
141 operationId: patchResourceDataRunningForCmHandle
143 - $ref: 'components.yaml#/components/parameters/datastoreName'
144 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
145 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
146 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
155 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
158 $ref: 'components.yaml#/components/responses/Ok'
160 $ref: 'components.yaml#/components/responses/BadRequest'
162 $ref: 'components.yaml#/components/responses/Unauthorized'
164 $ref: 'components.yaml#/components/responses/Forbidden'
166 $ref: 'components.yaml#/components/responses/InternalServerError'
168 $ref: 'components.yaml#/components/responses/BadGateway'
173 summary: Delete resource data
174 description: Delete resource data from pass-through running for a given cm handle
175 operationId: deleteResourceDataRunningForCmHandle
177 - $ref: 'components.yaml#/components/parameters/datastoreName'
178 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
179 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
180 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
183 $ref: 'components.yaml#/components/responses/NoContent'
185 $ref: 'components.yaml#/components/responses/BadRequest'
187 $ref: 'components.yaml#/components/responses/Unauthorized'
189 $ref: 'components.yaml#/components/responses/Forbidden'
191 $ref: 'components.yaml#/components/responses/NotFound'
193 $ref: 'components.yaml#/components/responses/InternalServerError'
195 $ref: 'components.yaml#/components/responses/BadGateway'
197 dataOperationForCmHandle:
201 summary: Execute a data operation for group of cm handle ids
202 description: This request will be handled asynchronously using messaging to the supplied topic. The rest response will be an acknowledge with a requestId to identify the relevant messages.
203 operationId: executeDataOperationForCmHandles
205 - $ref: 'components.yaml#/components/parameters/requiredTopicParamInQuery'
211 $ref: 'components.yaml#/components/schemas/DataOperationRequest'
220 $ref: 'components.yaml#/components/responses/BadRequest'
222 $ref: 'components.yaml#/components/responses/Unauthorized'
224 $ref: 'components.yaml#/components/responses/Forbidden'
226 $ref: 'components.yaml#/components/responses/InternalServerError'
228 $ref: 'components.yaml#/components/responses/BadGateway'
230 queryResourceDataForCmHandle:
234 summary: Query resource data for a given cm handle
235 description: Query resource data for a given cm handle
236 operationId: queryResourceDataForCmHandle
238 - $ref: 'components.yaml#/components/parameters/datastoreName'
239 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
240 - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
241 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
242 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
243 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
253 $ref: 'components.yaml#/components/examples/dataSampleResponse'
255 $ref: 'components.yaml#/components/responses/BadRequest'
257 $ref: 'components.yaml#/components/responses/Unauthorized'
259 $ref: 'components.yaml#/components/responses/Forbidden'
261 $ref: 'components.yaml#/components/responses/InternalServerError'
263 $ref: 'components.yaml#/components/responses/BadGateway'
265 fetchModuleReferencesByCmHandle:
267 description: fetch all module references (name and revision) for a given cm handle
270 summary: Fetch all module references (name and revision) for a given cm handle
271 operationId: getModuleReferencesByCmHandle
273 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
282 $ref: 'components.yaml#/components/schemas/RestModuleReference'
284 $ref: 'components.yaml#/components/responses/BadRequest'
286 $ref: 'components.yaml#/components/responses/Unauthorized'
288 $ref: 'components.yaml#/components/responses/Forbidden'
290 $ref: 'components.yaml#/components/responses/InternalServerError'
292 fetchModuleDefinitionsByCmHandle:
294 description: Fetch all module definitions (name, revision, yang resource) for a given cm handle
297 summary: Fetch all module definitions (name, revision, yang resource) for a given cm handle
298 operationId: getModuleDefinitionsByCmHandleId
300 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
309 $ref: 'components.yaml#/components/schemas/RestModuleDefinition'
311 $ref: 'components.yaml#/components/responses/Unauthorized'
313 $ref: 'components.yaml#/components/responses/Forbidden'
315 $ref: 'components.yaml#/components/responses/InternalServerError'
319 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.
322 summary: Execute cm handle search using the available conditions
323 operationId: searchCmHandles
329 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
331 Cm handle properties query:
332 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
333 Cm handle modules query:
334 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
335 All cm handle query parameters:
336 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
337 Cm handle with CPS path state query:
338 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
339 Cm handle with data sync flag query:
340 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
349 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
351 $ref: 'components.yaml#/components/responses/BadRequest'
353 $ref: 'components.yaml#/components/responses/Unauthorized'
355 $ref: 'components.yaml#/components/responses/Forbidden'
357 $ref: 'components.yaml#/components/responses/InternalServerError'
359 retrieveCmHandleDetailsById:
361 description: Retrieve CM handle details and properties by cm handle id
364 summary: Retrieve CM handle details
365 operationId: retrieveCmHandleDetailsById
367 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
374 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
376 $ref: 'components.yaml#/components/responses/BadRequest'
378 $ref: 'components.yaml#/components/responses/Unauthorized'
380 $ref: 'components.yaml#/components/responses/NotFound'
382 $ref: 'components.yaml#/components/responses/InternalServerError'
384 getCmHandlePropertiesById:
386 description: Get CM handle properties by cm handle id
389 summary: Get CM handle properties
390 operationId: getCmHandlePublicPropertiesByCmHandleId
392 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
399 $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
401 $ref: 'components.yaml#/components/responses/BadRequest'
403 $ref: 'components.yaml#/components/responses/Unauthorized'
405 $ref: 'components.yaml#/components/responses/NotFound'
407 $ref: 'components.yaml#/components/responses/InternalServerError'
409 getCmHandleStateById:
411 description: Get CM handle state by cm handle id
414 summary: Get CM handle state
415 operationId: getCmHandleStateByCmHandleId
417 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
424 $ref: 'components.yaml#/components/schemas/RestOutputCmHandleCompositeState'
426 $ref: 'components.yaml#/components/responses/BadRequest'
428 $ref: 'components.yaml#/components/responses/Unauthorized'
430 $ref: 'components.yaml#/components/responses/NotFound'
432 $ref: 'components.yaml#/components/responses/InternalServerError'
436 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.
439 summary: Execute cm handle query upon a given set of query parameters
440 operationId: searchCmHandleIds
446 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
448 Cm handle properties query:
449 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
450 Cm handle modules query:
451 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
452 All cm handle query parameters:
453 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
454 Cm handle with CPS path state query:
455 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
456 Cm handle with data sync flag query:
457 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
468 $ref: 'components.yaml#/components/responses/BadRequest'
470 $ref: 'components.yaml#/components/responses/Unauthorized'
472 $ref: 'components.yaml#/components/responses/Forbidden'
474 $ref: 'components.yaml#/components/responses/NotFound'
476 $ref: 'components.yaml#/components/responses/InternalServerError'
478 setDataSyncEnabledFlag:
482 summary: Set the Data Sync Enabled Flag
483 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.
484 operationId: setDataSyncEnabledFlagForCmHandle
486 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
487 - $ref: 'components.yaml#/components/parameters/dataSyncEnabled'
490 $ref: 'components.yaml#/components/responses/Ok'
492 $ref: 'components.yaml#/components/responses/BadRequest'
494 $ref: 'components.yaml#/components/responses/Unauthorized'
496 $ref: 'components.yaml#/components/responses/Forbidden'
498 $ref: 'components.yaml#/components/responses/InternalServerError'
500 $ref: 'components.yaml#/components/responses/BadGateway'