blob: 38db26f4708809929fb46753bb7141cbb118cdd2 [file] [log] [blame]
tragait34a94b92021-03-30 12:02:27 +01001# ============LICENSE_START=======================================================
mpriyankfd500182022-01-18 01:07:00 +05302# Copyright (C) 2021-2022 Nordix Foundation
lukegleeson15b93e72021-07-07 15:25:30 +01003# Modifications Copyright (C) 2021 Pantheon.tech
puthuparambil.adityad69742c2022-03-29 11:03:52 +01004# Modifications Copyright (C) 2021-2022 Bell Canada
tragait34a94b92021-03-30 12:02:27 +01005# ================================================================================
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 +010011#
tragait34a94b92021-03-30 12:02:27 +010012# 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 +020020
bmiklos440dc8a2022-09-05 18:25:46 +020021resourceDataForCmHandle:
tragaitc3285512021-08-16 15:12:36 +010022 get:
23 tags:
24 - network-cm-proxy
bmiklosbbaf5012022-08-25 18:28:16 +020025 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 +010028 parameters:
bmiklosbbaf5012022-08-25 18:28:16 +020029 - $ref: 'components.yaml#/components/parameters/datastoreName'
tragaitc3285512021-08-16 15:12:36 +010030 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +010031 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitabdff1b2021-10-06 11:04:18 +010032 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
sourabh_sourabh1f2e66e2022-02-16 21:53:41 +053033 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
bmiklosbbaf5012022-08-25 18:28:16 +020034 - $ref: 'components.yaml#/components/parameters/includeDescendantsOptionInQuery'
tragaitc3285512021-08-16 15:12:36 +010035 responses:
36 200:
emaclee844cab32021-12-01 09:42:37 +000037 description: OK
38 content:
39 application/json:
40 schema:
41 type: object
42 examples:
43 dataSampleResponse:
44 $ref: 'components.yaml#/components/examples/dataSampleResponse'
tragaitc3285512021-08-16 15:12:36 +010045 400:
46 $ref: 'components.yaml#/components/responses/BadRequest'
47 401:
48 $ref: 'components.yaml#/components/responses/Unauthorized'
49 403:
50 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +000051 500:
52 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +053053 502:
54 $ref: 'components.yaml#/components/responses/BadGateway'
tragait888dcd42021-08-19 15:17:56 +010055
tragaitc584bf22021-08-20 15:45:58 +010056 post:
57 tags:
58 - network-cm-proxy
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
62 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +020063 - $ref: 'components.yaml#/components/parameters/datastoreName'
tragaitc584bf22021-08-20 15:45:58 +010064 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +010065 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitc584bf22021-08-20 15:45:58 +010066 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
67 requestBody:
68 required: true
69 content:
70 application/json:
71 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +000072 type: object
emaclee844cab32021-12-01 09:42:37 +000073 examples:
74 dataSampleRequest:
75 $ref: 'components.yaml#/components/examples/dataSampleRequest'
tragaitc584bf22021-08-20 15:45:58 +010076 application/yang-data+json:
77 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +000078 type: object
79 examples:
80 dataSampleRequest:
81 $ref: 'components.yaml#/components/examples/dataSampleRequest'
tragaitc584bf22021-08-20 15:45:58 +010082 responses:
83 201:
84 $ref: 'components.yaml#/components/responses/Created'
85 400:
86 $ref: 'components.yaml#/components/responses/BadRequest'
87 401:
88 $ref: 'components.yaml#/components/responses/Unauthorized'
89 403:
90 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +000091 500:
92 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +053093 502:
94 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcorec309f242021-09-07 10:27:18 +010095
niamhcore919e9062021-11-02 14:08:16 +000096 put:
97 tags:
98 - network-cm-proxy
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
102 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200103 - $ref: 'components.yaml#/components/parameters/datastoreName'
niamhcore919e9062021-11-02 14:08:16 +0000104 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
105 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
106 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
107 requestBody:
108 required: true
109 content:
110 application/json:
111 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000112 type: object
emaclee844cab32021-12-01 09:42:37 +0000113 examples:
114 dataSampleRequest:
115 $ref: 'components.yaml#/components/examples/dataSampleRequest'
niamhcore919e9062021-11-02 14:08:16 +0000116 application/yang-data+json:
117 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000118 type: object
119 examples:
120 dataSampleRequest:
121 $ref: 'components.yaml#/components/examples/dataSampleRequest'
niamhcore919e9062021-11-02 14:08:16 +0000122 responses:
123 200:
124 $ref: 'components.yaml#/components/responses/Ok'
125 400:
126 $ref: 'components.yaml#/components/responses/BadRequest'
127 401:
128 $ref: 'components.yaml#/components/responses/Unauthorized'
129 403:
130 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000131 500:
132 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530133 502:
134 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcore919e9062021-11-02 14:08:16 +0000135
niamhcore4314e7b2021-11-24 10:53:51 +0000136 patch:
137 tags:
138 - network-cm-proxy
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
142 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200143 - $ref: 'components.yaml#/components/parameters/datastoreName'
niamhcore4314e7b2021-11-24 10:53:51 +0000144 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
145 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
146 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
147 requestBody:
148 required: true
149 content:
tragaitecd7f5e2022-01-13 13:15:14 +0000150 '*/*':
niamhcore4314e7b2021-11-24 10:53:51 +0000151 schema:
152 type: object
puthuparambil.adityad0007332021-12-08 18:53:39 +0000153 examples:
154 dataSampleRequest:
tragaitecd7f5e2022-01-13 13:15:14 +0000155 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
niamhcore4314e7b2021-11-24 10:53:51 +0000156 responses:
157 200:
158 $ref: 'components.yaml#/components/responses/Ok'
159 400:
160 $ref: 'components.yaml#/components/responses/BadRequest'
161 401:
162 $ref: 'components.yaml#/components/responses/Unauthorized'
163 403:
164 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000165 500:
166 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530167 502:
168 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcore4314e7b2021-11-24 10:53:51 +0000169
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000170 delete:
171 tags:
172 - network-cm-proxy
173 summary: Delete resource data
174 description: Delete resource data from pass-through running for a given cm handle
175 operationId: deleteResourceDataRunningForCmHandle
176 parameters:
bmiklos440dc8a2022-09-05 18:25:46 +0200177 - $ref: 'components.yaml#/components/parameters/datastoreName'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000178 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
179 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
180 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000181 responses:
182 204:
183 $ref: 'components.yaml#/components/responses/NoContent'
184 400:
185 $ref: 'components.yaml#/components/responses/BadRequest'
186 401:
187 $ref: 'components.yaml#/components/responses/Unauthorized'
188 403:
189 $ref: 'components.yaml#/components/responses/Forbidden'
190 404:
191 $ref: 'components.yaml#/components/responses/NotFound'
JosephKeenane0873dd2022-01-28 11:22:22 +0000192 500:
193 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530194 502:
195 $ref: 'components.yaml#/components/responses/BadGateway'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000196
niamhcorec309f242021-09-07 10:27:18 +0100197fetchModuleReferencesByCmHandle:
198 get:
199 description: fetch all module references (name and revision) for a given cm handle
200 tags:
201 - network-cm-proxy
202 summary: Fetch all module references (name and revision) for a given cm handle
203 operationId: getModuleReferencesByCmHandle
204 parameters:
205 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
206 responses:
207 200:
208 description: OK
209 content:
210 application/json:
211 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000212 type: array
213 items:
lukegleesond5bda882022-03-02 14:32:47 +0000214 $ref: 'components.yaml#/components/schemas/RestModuleReference'
niamhcorec309f242021-09-07 10:27:18 +0100215 400:
216 $ref: 'components.yaml#/components/responses/BadRequest'
217 401:
218 $ref: 'components.yaml#/components/responses/Unauthorized'
219 403:
220 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000221 500:
222 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcore66017b42021-10-19 11:07:02 +0100223
emacleee1f73e22022-06-17 17:42:56 +0100224fetchModuleDefinitionsByCmHandle:
225 get:
226 description: Fetch all module definitions (name, revision, yang resource) for a given cm handle
227 tags:
228 - network-cm-proxy
229 summary: Fetch all module definitions (name, revision, yang resource) for a given cm handle
230 operationId: getModuleDefinitionsByCmHandleId
231 parameters:
232 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
233 responses:
234 200:
235 description: OK
236 content:
237 application/json:
238 schema:
239 type: array
240 items:
241 $ref: 'components.yaml#/components/schemas/RestModuleDefinition'
242 401:
243 $ref: 'components.yaml#/components/responses/Unauthorized'
244 403:
245 $ref: 'components.yaml#/components/responses/Forbidden'
246 500:
247 $ref: 'components.yaml#/components/responses/InternalServerError'
248
kissande9ed5812022-05-12 15:59:18 +0200249searchCmHandles:
niamhcore66017b42021-10-19 11:07:02 +0100250 post:
lukegleesonde294742022-07-25 11:00:11 +0100251 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 +0100252 tags:
253 - network-cm-proxy
254 summary: Execute cm handle search using the available conditions
kissande9ed5812022-05-12 15:59:18 +0200255 operationId: searchCmHandles
niamhcore66017b42021-10-19 11:07:02 +0100256 requestBody:
257 required: true
258 content:
259 application/json:
260 schema:
kissande9ed5812022-05-12 15:59:18 +0200261 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
lukegleeson82a550f2022-07-11 10:55:53 +0100262 examples:
263 Cm handle properties query:
264 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
265 Cm handle modules query:
266 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
267 All cm handle query parameters:
268 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
269 Cm handle with CPS path state query:
270 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
271 Cm handle with data sync flag query:
272 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
niamhcore66017b42021-10-19 11:07:02 +0100273 responses:
274 200:
275 description: OK
276 content:
277 application/json:
278 schema:
kissande9ed5812022-05-12 15:59:18 +0200279 type: array
280 items:
281 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
niamhcore66017b42021-10-19 11:07:02 +0100282 400:
283 $ref: 'components.yaml#/components/responses/BadRequest'
284 401:
285 $ref: 'components.yaml#/components/responses/Unauthorized'
286 403:
ToineSiebelink18a79eb2021-12-23 12:36:40 +0000287 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000288 500:
289 $ref: 'components.yaml#/components/responses/InternalServerError'
DylanB95ESTe5573382022-01-27 17:12:52 +0000290
291retrieveCmHandleDetailsById:
292 get:
293 description: Retrieve CM handle details and properties by cm handle id
294 tags:
295 - network-cm-proxy
296 summary: Retrieve CM handle details
297 operationId: retrieveCmHandleDetailsById
298 parameters:
299 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
300 responses:
301 200:
302 description: OK
303 content:
304 application/json:
305 schema:
306 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
lukegleeson78062a12022-06-02 10:56:43 +0100307 400:
308 $ref: 'components.yaml#/components/responses/BadRequest'
309 401:
310 $ref: 'components.yaml#/components/responses/Unauthorized'
JosephKeenandeac4772022-03-28 12:26:07 +0100311 404:
312 $ref: 'components.yaml#/components/responses/NotFound'
313 500:
314 $ref: 'components.yaml#/components/responses/InternalServerError'
315
lukegleesonbed18fd2022-05-06 12:02:42 +0100316getCmHandlePropertiesById:
317 get:
318 description: Get CM handle properties by cm handle id
319 tags:
320 - network-cm-proxy
321 summary: Get CM handle properties
322 operationId: getCmHandlePublicPropertiesByCmHandleId
323 parameters:
324 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
325 responses:
326 200:
327 description: OK
328 content:
329 application/json:
330 schema:
331 $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
lukegleeson78062a12022-06-02 10:56:43 +0100332 400:
333 $ref: 'components.yaml#/components/responses/BadRequest'
334 401:
335 $ref: 'components.yaml#/components/responses/Unauthorized'
336 404:
337 $ref: 'components.yaml#/components/responses/NotFound'
338 500:
339 $ref: 'components.yaml#/components/responses/InternalServerError'
340
341getCmHandleStateById:
342 get:
343 description: Get CM handle state by cm handle id
344 tags:
345 - network-cm-proxy
346 summary: Get CM handle state
347 operationId: getCmHandleStateByCmHandleId
348 parameters:
349 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
350 responses:
351 200:
352 description: OK
353 content:
354 application/json:
355 schema:
356 $ref: 'components.yaml#/components/schemas/RestOutputCmHandleCompositeState'
357 400:
358 $ref: 'components.yaml#/components/responses/BadRequest'
359 401:
360 $ref: 'components.yaml#/components/responses/Unauthorized'
lukegleesonbed18fd2022-05-06 12:02:42 +0100361 404:
362 $ref: 'components.yaml#/components/responses/NotFound'
363 500:
364 $ref: 'components.yaml#/components/responses/InternalServerError'
365
kissande9ed5812022-05-12 15:59:18 +0200366searchCmHandleIds:
JosephKeenandeac4772022-03-28 12:26:07 +0100367 post:
lukegleesonde294742022-07-25 11:00:11 +0100368 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 +0100369 tags:
370 - network-cm-proxy
371 summary: Execute cm handle query upon a given set of query parameters
kissande9ed5812022-05-12 15:59:18 +0200372 operationId: searchCmHandleIds
JosephKeenandeac4772022-03-28 12:26:07 +0100373 requestBody:
374 required: true
375 content:
376 application/json:
377 schema:
kissande9ed5812022-05-12 15:59:18 +0200378 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
lukegleeson82a550f2022-07-11 10:55:53 +0100379 examples:
380 Cm handle properties query:
381 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
382 Cm handle modules query:
383 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
384 All cm handle query parameters:
385 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
386 Cm handle with CPS path state query:
387 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
388 Cm handle with data sync flag query:
389 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
JosephKeenandeac4772022-03-28 12:26:07 +0100390 responses:
391 200:
392 description: OK
393 content:
394 application/json:
395 schema:
396 type: array
397 items:
398 type: string
DylanB95ESTe5573382022-01-27 17:12:52 +0000399 400:
400 $ref: 'components.yaml#/components/responses/BadRequest'
401 401:
402 $ref: 'components.yaml#/components/responses/Unauthorized'
403 403:
404 $ref: 'components.yaml#/components/responses/Forbidden'
405 404:
406 $ref: 'components.yaml#/components/responses/NotFound'
407 500:
DylanB95EST6ddbe4a2022-07-19 11:36:10 +0100408 $ref: 'components.yaml#/components/responses/InternalServerError'
409
410setDataSyncEnabledFlag:
411 put:
412 tags:
413 - network-cm-proxy
414 summary: Set the Data Sync Enabled Flag
415 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.
416 operationId: setDataSyncEnabledFlagForCmHandle
417 parameters:
418 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
419 - $ref: 'components.yaml#/components/parameters/dataSyncEnabled'
420 responses:
421 200:
422 $ref: 'components.yaml#/components/responses/Ok'
423 400:
424 $ref: 'components.yaml#/components/responses/BadRequest'
425 401:
426 $ref: 'components.yaml#/components/responses/Unauthorized'
427 403:
428 $ref: 'components.yaml#/components/responses/Forbidden'
429 500:
430 $ref: 'components.yaml#/components/responses/InternalServerError'
431 502:
432 $ref: 'components.yaml#/components/responses/BadGateway'