Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / fc49910404bf3868788e4b8d91d93047ce297f4d / . / cps-ncmp-rest / docs / openapi / ncmp.yml
blob: adb2419c8af0e5940a50e9f4344032d9081be189 [file] [log] [blame]
tragait34a94b92021-03-30 12:02:27 +0100[diff] [blame]1# ============LICENSE_START=======================================================
halil.cakal04280e22024-01-23 10:05:36 +0000[diff] [blame]2# Copyright (C) 2021-2024 Nordix Foundation
lukegleeson15b93e72021-07-07 15:25:30 +0100[diff] [blame]3# Modifications Copyright (C) 2021 Pantheon.tech
puthuparambil.adityad69742c2022-03-29 11:03:52 +0100[diff] [blame]4# Modifications Copyright (C) 2021-2022 Bell Canada
tragait34a94b92021-03-30 12:02:27 +0100[diff] [blame]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
9#
10# http://www.apache.org/licenses/LICENSE-2.0
lukegleeson15b93e72021-07-07 15:25:30 +0100[diff] [blame]11#
tragait34a94b92021-03-30 12:02:27 +0100[diff] [blame]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.
17#
18# SPDX-License-Identifier: Apache-2.0
19# ============LICENSE_END=========================================================
bmiklosbbaf5012022-08-25 18:28:16 +0200[diff] [blame]20
bmiklos440dc8a2022-09-05 18:25:46 +0200[diff] [blame]21resourceDataForCmHandle:
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]22 get:
23 tags:
24 - network-cm-proxy
bmiklosbbaf5012022-08-25 18:28:16 +0200[diff] [blame]25 summary: Get resource data for cm handle
26 description: Get resource data for given cm handle
27 operationId: getResourceDataForCmHandle
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]28 parameters:
bmiklosbbaf5012022-08-25 18:28:16 +0200[diff] [blame]29 - $ref: 'components.yaml#/components/parameters/datastoreName'
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]30 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +0100[diff] [blame]31 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitabdff1b2021-10-06 11:04:18 +0100[diff] [blame]32 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
sourabh_sourabh1f2e66e2022-02-16 21:53:41 +0530[diff] [blame]33 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
bmiklosbbaf5012022-08-25 18:28:16 +0200[diff] [blame]34 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]35 - $ref: 'components.yaml#/components/parameters/authorizationParamInHeader'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]36 responses:
37 200:
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]38 description: OK
39 content:
40 application/json:
41 schema:
42 type: object
43 examples:
44 dataSampleResponse:
45 $ref: 'components.yaml#/components/examples/dataSampleResponse'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]46 400:
47 $ref: 'components.yaml#/components/responses/BadRequest'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]48 403:
49 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]50 500:
51 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]52 502:
53 $ref: 'components.yaml#/components/responses/BadGateway'
tragait888dcd42021-08-19 15:17:56 +0100[diff] [blame]54
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]55 post:
56 tags:
57 - network-cm-proxy
58 summary: create resource data from pass-through running for cm handle
59 description: create resource data from pass-through running for given cm handle
60 operationId: createResourceDataRunningForCmHandle
61 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200[diff] [blame]62 - $ref: 'components.yaml#/components/parameters/datastoreName'
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]63 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +0100[diff] [blame]64 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]65 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]66 - $ref: 'components.yaml#/components/parameters/authorizationParamInHeader'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]67 requestBody:
68 required: true
69 content:
70 application/json:
71 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]72 type: object
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]73 examples:
74 dataSampleRequest:
75 $ref: 'components.yaml#/components/examples/dataSampleRequest'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]76 application/yang-data+json:
77 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]78 type: object
79 examples:
80 dataSampleRequest:
81 $ref: 'components.yaml#/components/examples/dataSampleRequest'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]82 responses:
83 201:
84 $ref: 'components.yaml#/components/responses/Created'
85 400:
86 $ref: 'components.yaml#/components/responses/BadRequest'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]87 403:
88 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]89 500:
90 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]91 502:
92 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]93
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]94 put:
95 tags:
96 - network-cm-proxy
97 summary: Update resource data from pass-through running for a cm handle
98 description: Update resource data from pass-through running for the given cm handle
99 operationId: updateResourceDataRunningForCmHandle
100 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200[diff] [blame]101 - $ref: 'components.yaml#/components/parameters/datastoreName'
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]102 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]103 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
104 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]105 - $ref: 'components.yaml#/components/parameters/authorizationParamInHeader'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]106 requestBody:
107 required: true
108 content:
109 application/json:
110 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]111 type: object
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]112 examples:
113 dataSampleRequest:
114 $ref: 'components.yaml#/components/examples/dataSampleRequest'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]115 application/yang-data+json:
116 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]117 type: object
118 examples:
119 dataSampleRequest:
120 $ref: 'components.yaml#/components/examples/dataSampleRequest'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]121 responses:
122 200:
123 $ref: 'components.yaml#/components/responses/Ok'
124 400:
125 $ref: 'components.yaml#/components/responses/BadRequest'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]126 403:
127 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]128 500:
129 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]130 502:
131 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]132
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]133 patch:
134 tags:
135 - network-cm-proxy
136 summary: Patch resource data from pass-through running
137 description: Patch resource data from pass-through running for the given cm handle
138 operationId: patchResourceDataRunningForCmHandle
139 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200[diff] [blame]140 - $ref: 'components.yaml#/components/parameters/datastoreName'
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]141 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]142 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
143 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]144 - $ref: 'components.yaml#/components/parameters/authorizationParamInHeader'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]145 requestBody:
146 required: true
147 content:
tragaitecd7f5e2022-01-13 13:15:14 +0000[diff] [blame]148 '*/*':
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]149 schema:
150 type: object
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]151 examples:
152 dataSampleRequest:
tragaitecd7f5e2022-01-13 13:15:14 +0000[diff] [blame]153 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]154 responses:
155 200:
156 $ref: 'components.yaml#/components/responses/Ok'
157 400:
158 $ref: 'components.yaml#/components/responses/BadRequest'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]159 403:
160 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]161 500:
162 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]163 502:
164 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]165
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]166 delete:
167 tags:
168 - network-cm-proxy
169 summary: Delete resource data
170 description: Delete resource data from pass-through running for a given cm handle
171 operationId: deleteResourceDataRunningForCmHandle
172 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200[diff] [blame]173 - $ref: 'components.yaml#/components/parameters/datastoreName'
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]174 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]175 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
176 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]177 - $ref: 'components.yaml#/components/parameters/authorizationParamInHeader'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]178 responses:
179 204:
180 $ref: 'components.yaml#/components/responses/NoContent'
181 400:
182 $ref: 'components.yaml#/components/responses/BadRequest'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]183 403:
184 $ref: 'components.yaml#/components/responses/Forbidden'
185 404:
186 $ref: 'components.yaml#/components/responses/NotFound'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]187 500:
188 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]189 502:
190 $ref: 'components.yaml#/components/responses/BadGateway'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]191
raviteja.karumuri977f7c32023-06-20 19:10:21 +0100[diff] [blame]192dataOperationForCmHandle:
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]193 post:
194 tags:
195 - network-cm-proxy
raviteja.karumuri977f7c32023-06-20 19:10:21 +0100[diff] [blame]196 summary: Execute a data operation for group of cm handle ids
mpriyank810be172024-07-29 16:11:53 +0100[diff] [blame]197 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. A maximum of 200 cm handles per operation is supported.
raviteja.karumuri977f7c32023-06-20 19:10:21 +0100[diff] [blame]198 operationId: executeDataOperationForCmHandles
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]199 parameters:
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]200 - $ref: 'components.yaml#/components/parameters/requiredTopicParamInQuery'
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]201 - $ref: 'components.yaml#/components/parameters/authorizationParamInHeader'
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]202 requestBody:
203 required: true
204 content:
205 application/json:
206 schema:
raviteja.karumuri977f7c32023-06-20 19:10:21 +0100[diff] [blame]207 $ref: 'components.yaml#/components/schemas/DataOperationRequest'
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]208 responses:
209 200:
210 description: OK
211 content:
212 application/json:
213 schema:
214 type: object
215 400:
216 $ref: 'components.yaml#/components/responses/BadRequest'
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]217 403:
218 $ref: 'components.yaml#/components/responses/Forbidden'
ToineSiebelink693cfdd2024-04-09 18:39:51 +0100[diff] [blame]219 413:
220 $ref: 'components.yaml#/components/responses/PayloadTooLarge'
sourabh_sourabh4031d432023-03-27 14:36:20 +0100[diff] [blame]221 500:
222 $ref: 'components.yaml#/components/responses/InternalServerError'
223 502:
224 $ref: 'components.yaml#/components/responses/BadGateway'
225
lukegleeson20e7a732022-10-20 10:14:00 +0100[diff] [blame]226queryResourceDataForCmHandle:
227 get:
228 tags:
229 - network-cm-proxy
230 summary: Query resource data for a given cm handle
231 description: Query resource data for a given cm handle
232 operationId: queryResourceDataForCmHandle
233 parameters:
234 - $ref: 'components.yaml#/components/parameters/datastoreName'
235 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
236 - $ref: 'components.yaml#/components/parameters/cpsPathInQuery'
237 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
238 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
239 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
240 responses:
241 200:
242 description: OK
243 content:
244 application/json:
245 schema:
246 type: object
247 examples:
248 dataSampleResponse:
249 $ref: 'components.yaml#/components/examples/dataSampleResponse'
250 400:
251 $ref: 'components.yaml#/components/responses/BadRequest'
lukegleeson20e7a732022-10-20 10:14:00 +0100[diff] [blame]252 403:
253 $ref: 'components.yaml#/components/responses/Forbidden'
254 500:
255 $ref: 'components.yaml#/components/responses/InternalServerError'
256 502:
257 $ref: 'components.yaml#/components/responses/BadGateway'
258
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]259fetchModuleReferencesByCmHandle:
260 get:
261 description: fetch all module references (name and revision) for a given cm handle
262 tags:
263 - network-cm-proxy
264 summary: Fetch all module references (name and revision) for a given cm handle
265 operationId: getModuleReferencesByCmHandle
266 parameters:
seanbeirne196fc122024-08-26 10:48:20 +0100[diff] [blame]267 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]268 responses:
269 200:
270 description: OK
271 content:
272 application/json:
273 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]274 type: array
275 items:
lukegleesond5bda882022-03-02 14:32:47 +0000[diff] [blame]276 $ref: 'components.yaml#/components/schemas/RestModuleReference'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]277 400:
278 $ref: 'components.yaml#/components/responses/BadRequest'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]279 403:
280 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]281 500:
282 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]283
halil.cakal04280e22024-01-23 10:05:36 +0000[diff] [blame]284getModuleDefinitions:
emacleee1f73e22022-06-17 17:42:56 +0100[diff] [blame]285 get:
emacleee1f73e22022-06-17 17:42:56 +0100[diff] [blame]286 tags:
287 - network-cm-proxy
halil.cakal04280e22024-01-23 10:05:36 +0000[diff] [blame]288 summary: Get module definitions
289 description: Get module definitions (module name, revision, yang resource) with options to filter on module name and revision
290 operationId: getModuleDefinitions
emacleee1f73e22022-06-17 17:42:56 +0100[diff] [blame]291 parameters:
seanbeirne081f6052024-08-26 14:13:29 +0100[diff] [blame]292 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
halil.cakal04280e22024-01-23 10:05:36 +0000[diff] [blame]293 - $ref: 'components.yaml#/components/parameters/moduleNameInQuery'
294 - $ref: 'components.yaml#/components/parameters/revisionInQuery'
emacleee1f73e22022-06-17 17:42:56 +0100[diff] [blame]295 responses:
296 200:
297 description: OK
298 content:
299 application/json:
300 schema:
301 type: array
302 items:
303 $ref: 'components.yaml#/components/schemas/RestModuleDefinition'
emacleee1f73e22022-06-17 17:42:56 +0100[diff] [blame]304 403:
305 $ref: 'components.yaml#/components/responses/Forbidden'
306 500:
307 $ref: 'components.yaml#/components/responses/InternalServerError'
308
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]309searchCmHandles:
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]310 post:
lukegleesonde294742022-07-25 11:00:11 +0100[diff] [blame]311 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.
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]312 tags:
313 - network-cm-proxy
314 summary: Execute cm handle search using the available conditions
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]315 operationId: searchCmHandles
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]316 requestBody:
317 required: true
318 content:
319 application/json:
320 schema:
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]321 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
lukegleeson82a550f2022-07-11 10:55:53 +0100[diff] [blame]322 examples:
323 Cm handle properties query:
324 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
325 Cm handle modules query:
326 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
327 All cm handle query parameters:
328 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
329 Cm handle with CPS path state query:
330 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
331 Cm handle with data sync flag query:
332 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]333 responses:
334 200:
335 description: OK
336 content:
337 application/json:
338 schema:
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]339 type: array
340 items:
341 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]342 400:
343 $ref: 'components.yaml#/components/responses/BadRequest'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]344 403:
ToineSiebelink18a79eb2021-12-23 12:36:40 +0000[diff] [blame]345 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]346 500:
347 $ref: 'components.yaml#/components/responses/InternalServerError'
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]348
349retrieveCmHandleDetailsById:
350 get:
351 description: Retrieve CM handle details and properties by cm handle id
352 tags:
353 - network-cm-proxy
354 summary: Retrieve CM handle details
355 operationId: retrieveCmHandleDetailsById
356 parameters:
mpriyank1721e3c2024-09-03 17:00:17 +0100[diff] [blame]357 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]358 responses:
359 200:
360 description: OK
361 content:
362 application/json:
363 schema:
364 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
lukegleeson78062a12022-06-02 10:56:43 +0100[diff] [blame]365 400:
366 $ref: 'components.yaml#/components/responses/BadRequest'
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]367 404:
368 $ref: 'components.yaml#/components/responses/NotFound'
369 500:
370 $ref: 'components.yaml#/components/responses/InternalServerError'
371
lukegleesonbed18fd2022-05-06 12:02:42 +0100[diff] [blame]372getCmHandlePropertiesById:
373 get:
374 description: Get CM handle properties by cm handle id
375 tags:
376 - network-cm-proxy
377 summary: Get CM handle properties
378 operationId: getCmHandlePublicPropertiesByCmHandleId
379 parameters:
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]380 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
lukegleesonbed18fd2022-05-06 12:02:42 +0100[diff] [blame]381 responses:
382 200:
383 description: OK
384 content:
385 application/json:
386 schema:
387 $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
lukegleeson78062a12022-06-02 10:56:43 +0100[diff] [blame]388 400:
389 $ref: 'components.yaml#/components/responses/BadRequest'
lukegleeson78062a12022-06-02 10:56:43 +0100[diff] [blame]390 404:
391 $ref: 'components.yaml#/components/responses/NotFound'
392 500:
393 $ref: 'components.yaml#/components/responses/InternalServerError'
394
395getCmHandleStateById:
396 get:
397 description: Get CM handle state by cm handle id
398 tags:
399 - network-cm-proxy
400 summary: Get CM handle state
401 operationId: getCmHandleStateByCmHandleId
402 parameters:
mpriyank45308e02024-08-27 16:08:31 +0100[diff] [blame]403 - $ref: 'components.yaml#/components/parameters/cmHandleReferenceInPath'
lukegleeson78062a12022-06-02 10:56:43 +0100[diff] [blame]404 responses:
405 200:
406 description: OK
407 content:
408 application/json:
409 schema:
410 $ref: 'components.yaml#/components/schemas/RestOutputCmHandleCompositeState'
411 400:
412 $ref: 'components.yaml#/components/responses/BadRequest'
lukegleesonbed18fd2022-05-06 12:02:42 +0100[diff] [blame]413 404:
414 $ref: 'components.yaml#/components/responses/NotFound'
415 500:
416 $ref: 'components.yaml#/components/responses/InternalServerError'
417
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]418searchCmHandleIds:
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]419 post:
lukegleesonde294742022-07-25 11:00:11 +0100[diff] [blame]420 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.
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]421 tags:
422 - network-cm-proxy
423 summary: Execute cm handle query upon a given set of query parameters
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]424 operationId: searchCmHandleIds
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]425 requestBody:
426 required: true
427 content:
428 application/json:
429 schema:
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]430 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
lukegleeson82a550f2022-07-11 10:55:53 +0100[diff] [blame]431 examples:
432 Cm handle properties query:
433 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
434 Cm handle modules query:
435 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
436 All cm handle query parameters:
437 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
438 Cm handle with CPS path state query:
439 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
440 Cm handle with data sync flag query:
441 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]442 responses:
443 200:
444 description: OK
445 content:
446 application/json:
447 schema:
448 type: array
449 items:
450 type: string
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]451 400:
452 $ref: 'components.yaml#/components/responses/BadRequest'
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]453 403:
454 $ref: 'components.yaml#/components/responses/Forbidden'
455 404:
456 $ref: 'components.yaml#/components/responses/NotFound'
457 500:
DylanB95EST6ddbe4a2022-07-19 11:36:10 +0100[diff] [blame]458 $ref: 'components.yaml#/components/responses/InternalServerError'
459
460setDataSyncEnabledFlag:
461 put:
462 tags:
463 - network-cm-proxy
464 summary: Set the Data Sync Enabled Flag
465 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.
466 operationId: setDataSyncEnabledFlagForCmHandle
467 parameters:
468 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
469 - $ref: 'components.yaml#/components/parameters/dataSyncEnabled'
470 responses:
471 200:
472 $ref: 'components.yaml#/components/responses/Ok'
473 400:
474 $ref: 'components.yaml#/components/responses/BadRequest'
DylanB95EST6ddbe4a2022-07-19 11:36:10 +0100[diff] [blame]475 403:
476 $ref: 'components.yaml#/components/responses/Forbidden'
477 500:
478 $ref: 'components.yaml#/components/responses/InternalServerError'
479 502:
danielhanrahanc5222a72024-02-28 16:05:07 +0000[diff] [blame]480 $ref: 'components.yaml#/components/responses/BadGateway'