Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / 19a59f369cbb348441d69d5e2675f17e0e1b7f3f / . / cps-ncmp-rest / docs / openapi / ncmp.yml
blob: 5e22f773aa899540009a4b44da9369f0bf4aa0ba [file] [log] [blame]
tragait34a94b92021-03-30 12:02:27 +0100[diff] [blame]1# ============LICENSE_START=======================================================
mpriyankfd500182022-01-18 01:07:00 +0530[diff] [blame]2# Copyright (C) 2021-2022 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
21getResourceDataForCmHandle:
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'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]30 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
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'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]35 responses:
36 200:
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]37 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 +0100[diff] [blame]45 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 +0000[diff] [blame]51 500:
52 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]53 502:
54 $ref: 'components.yaml#/components/responses/BadGateway'
tragait888dcd42021-08-19 15:17:56 +0100[diff] [blame]55
56resourceDataForPassthroughRunning:
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]57 post:
58 tags:
59 - network-cm-proxy
60 summary: create resource data from pass-through running for cm handle
61 description: create resource data from pass-through running for given cm handle
62 operationId: createResourceDataRunningForCmHandle
63 parameters:
64 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +0100[diff] [blame]65 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]66 - $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 +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'
87 401:
88 $ref: 'components.yaml#/components/responses/Unauthorized'
89 403:
90 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]91 500:
92 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]93 502:
94 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]95
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]96 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:
103 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
104 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
105 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
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'
126 401:
127 $ref: 'components.yaml#/components/responses/Unauthorized'
128 403:
129 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]130 500:
131 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]132 502:
133 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]134
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]135 patch:
136 tags:
137 - network-cm-proxy
138 summary: Patch resource data from pass-through running
139 description: Patch resource data from pass-through running for the given cm handle
140 operationId: patchResourceDataRunningForCmHandle
141 parameters:
142 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
143 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
144 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
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'
159 401:
160 $ref: 'components.yaml#/components/responses/Unauthorized'
161 403:
162 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]163 500:
164 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]165 502:
166 $ref: 'components.yaml#/components/responses/BadGateway'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]167
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]168 delete:
169 tags:
170 - network-cm-proxy
171 summary: Delete resource data
172 description: Delete resource data from pass-through running for a given cm handle
173 operationId: deleteResourceDataRunningForCmHandle
174 parameters:
175 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
176 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
177 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
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'
183 401:
184 $ref: 'components.yaml#/components/responses/Unauthorized'
185 403:
186 $ref: 'components.yaml#/components/responses/Forbidden'
187 404:
188 $ref: 'components.yaml#/components/responses/NotFound'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]189 500:
190 $ref: 'components.yaml#/components/responses/InternalServerError'
mpriyank93afc1e2022-03-28 15:47:47 +0530[diff] [blame]191 502:
192 $ref: 'components.yaml#/components/responses/BadGateway'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]193
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]194fetchModuleReferencesByCmHandle:
195 get:
196 description: fetch all module references (name and revision) for a given cm handle
197 tags:
198 - network-cm-proxy
199 summary: Fetch all module references (name and revision) for a given cm handle
200 operationId: getModuleReferencesByCmHandle
201 parameters:
202 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
203 responses:
204 200:
205 description: OK
206 content:
207 application/json:
208 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]209 type: array
210 items:
lukegleesond5bda882022-03-02 14:32:47 +0000[diff] [blame]211 $ref: 'components.yaml#/components/schemas/RestModuleReference'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]212 400:
213 $ref: 'components.yaml#/components/responses/BadRequest'
214 401:
215 $ref: 'components.yaml#/components/responses/Unauthorized'
216 403:
217 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]218 500:
219 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]220
emacleee1f73e22022-06-17 17:42:56 +0100[diff] [blame]221fetchModuleDefinitionsByCmHandle:
222 get:
223 description: Fetch all module definitions (name, revision, yang resource) for a given cm handle
224 tags:
225 - network-cm-proxy
226 summary: Fetch all module definitions (name, revision, yang resource) for a given cm handle
227 operationId: getModuleDefinitionsByCmHandleId
228 parameters:
229 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
230 responses:
231 200:
232 description: OK
233 content:
234 application/json:
235 schema:
236 type: array
237 items:
238 $ref: 'components.yaml#/components/schemas/RestModuleDefinition'
239 401:
240 $ref: 'components.yaml#/components/responses/Unauthorized'
241 403:
242 $ref: 'components.yaml#/components/responses/Forbidden'
243 500:
244 $ref: 'components.yaml#/components/responses/InternalServerError'
245
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]246searchCmHandles:
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]247 post:
lukegleesonde294742022-07-25 11:00:11 +0100[diff] [blame]248 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]249 tags:
250 - network-cm-proxy
251 summary: Execute cm handle search using the available conditions
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]252 operationId: searchCmHandles
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]253 requestBody:
254 required: true
255 content:
256 application/json:
257 schema:
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]258 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
lukegleeson82a550f2022-07-11 10:55:53 +0100[diff] [blame]259 examples:
260 Cm handle properties query:
261 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
262 Cm handle modules query:
263 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
264 All cm handle query parameters:
265 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
266 Cm handle with CPS path state query:
267 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
268 Cm handle with data sync flag query:
269 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]270 responses:
271 200:
272 description: OK
273 content:
274 application/json:
275 schema:
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]276 type: array
277 items:
278 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]279 400:
280 $ref: 'components.yaml#/components/responses/BadRequest'
281 401:
282 $ref: 'components.yaml#/components/responses/Unauthorized'
283 403:
ToineSiebelink18a79eb2021-12-23 12:36:40 +0000[diff] [blame]284 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]285 500:
286 $ref: 'components.yaml#/components/responses/InternalServerError'
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]287
288retrieveCmHandleDetailsById:
289 get:
290 description: Retrieve CM handle details and properties by cm handle id
291 tags:
292 - network-cm-proxy
293 summary: Retrieve CM handle details
294 operationId: retrieveCmHandleDetailsById
295 parameters:
296 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
297 responses:
298 200:
299 description: OK
300 content:
301 application/json:
302 schema:
303 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
lukegleeson78062a12022-06-02 10:56:43 +0100[diff] [blame]304 400:
305 $ref: 'components.yaml#/components/responses/BadRequest'
306 401:
307 $ref: 'components.yaml#/components/responses/Unauthorized'
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]308 404:
309 $ref: 'components.yaml#/components/responses/NotFound'
310 500:
311 $ref: 'components.yaml#/components/responses/InternalServerError'
312
lukegleesonbed18fd2022-05-06 12:02:42 +0100[diff] [blame]313getCmHandlePropertiesById:
314 get:
315 description: Get CM handle properties by cm handle id
316 tags:
317 - network-cm-proxy
318 summary: Get CM handle properties
319 operationId: getCmHandlePublicPropertiesByCmHandleId
320 parameters:
321 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
322 responses:
323 200:
324 description: OK
325 content:
326 application/json:
327 schema:
328 $ref: 'components.yaml#/components/schemas/RestOutputCmHandlePublicProperties'
lukegleeson78062a12022-06-02 10:56:43 +0100[diff] [blame]329 400:
330 $ref: 'components.yaml#/components/responses/BadRequest'
331 401:
332 $ref: 'components.yaml#/components/responses/Unauthorized'
333 404:
334 $ref: 'components.yaml#/components/responses/NotFound'
335 500:
336 $ref: 'components.yaml#/components/responses/InternalServerError'
337
338getCmHandleStateById:
339 get:
340 description: Get CM handle state by cm handle id
341 tags:
342 - network-cm-proxy
343 summary: Get CM handle state
344 operationId: getCmHandleStateByCmHandleId
345 parameters:
346 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
347 responses:
348 200:
349 description: OK
350 content:
351 application/json:
352 schema:
353 $ref: 'components.yaml#/components/schemas/RestOutputCmHandleCompositeState'
354 400:
355 $ref: 'components.yaml#/components/responses/BadRequest'
356 401:
357 $ref: 'components.yaml#/components/responses/Unauthorized'
lukegleesonbed18fd2022-05-06 12:02:42 +0100[diff] [blame]358 404:
359 $ref: 'components.yaml#/components/responses/NotFound'
360 500:
361 $ref: 'components.yaml#/components/responses/InternalServerError'
362
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]363searchCmHandleIds:
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]364 post:
lukegleesonde294742022-07-25 11:00:11 +0100[diff] [blame]365 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]366 tags:
367 - network-cm-proxy
368 summary: Execute cm handle query upon a given set of query parameters
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]369 operationId: searchCmHandleIds
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]370 requestBody:
371 required: true
372 content:
373 application/json:
374 schema:
kissande9ed5812022-05-12 15:59:18 +0200[diff] [blame]375 $ref: 'components.yaml#/components/schemas/CmHandleQueryParameters'
lukegleeson82a550f2022-07-11 10:55:53 +0100[diff] [blame]376 examples:
377 Cm handle properties query:
378 $ref: 'components.yaml#/components/examples/pubPropCmHandleQueryParameters'
379 Cm handle modules query:
380 $ref: 'components.yaml#/components/examples/modulesCmHandleQueryParameters'
381 All cm handle query parameters:
382 $ref: 'components.yaml#/components/examples/allCmHandleQueryParameters'
383 Cm handle with CPS path state query:
384 $ref: 'components.yaml#/components/examples/cpsPathCmHandleStateQueryParameters'
385 Cm handle with data sync flag query:
386 $ref: 'components.yaml#/components/examples/cpsPathCmHandleDataSyncQueryParameters'
JosephKeenandeac4772022-03-28 12:26:07 +0100[diff] [blame]387 responses:
388 200:
389 description: OK
390 content:
391 application/json:
392 schema:
393 type: array
394 items:
395 type: string
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]396 400:
397 $ref: 'components.yaml#/components/responses/BadRequest'
398 401:
399 $ref: 'components.yaml#/components/responses/Unauthorized'
400 403:
401 $ref: 'components.yaml#/components/responses/Forbidden'
402 404:
403 $ref: 'components.yaml#/components/responses/NotFound'
404 500:
DylanB95EST6ddbe4a2022-07-19 11:36:10 +0100[diff] [blame]405 $ref: 'components.yaml#/components/responses/InternalServerError'
406
407setDataSyncEnabledFlag:
408 put:
409 tags:
410 - network-cm-proxy
411 summary: Set the Data Sync Enabled Flag
412 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.
413 operationId: setDataSyncEnabledFlagForCmHandle
414 parameters:
415 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
416 - $ref: 'components.yaml#/components/parameters/dataSyncEnabled'
417 responses:
418 200:
419 $ref: 'components.yaml#/components/responses/Ok'
420 400:
421 $ref: 'components.yaml#/components/responses/BadRequest'
422 401:
423 $ref: 'components.yaml#/components/responses/Unauthorized'
424 403:
425 $ref: 'components.yaml#/components/responses/Forbidden'
426 500:
427 $ref: 'components.yaml#/components/responses/InternalServerError'
428 502:
429 $ref: 'components.yaml#/components/responses/BadGateway'