Gitiles
Code Review Sign In
gerrit.nordix.org / onap / cps / ae74cfd469d290a2a9ede5e8ae10fed4851dbbf0 / . / cps-ncmp-rest / docs / openapi / ncmp.yml
blob: a9d08b79512b591c5c800b640d4b9533e578980d [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
Renu Kumari139e8222021-10-04 20:59:18 -0400[diff] [blame]4# Modifications Copyright (C) 2021 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=========================================================
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]20getResourceDataForPassthroughOperational:
21 get:
22 tags:
23 - network-cm-proxy
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
27 parameters:
28 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +0100[diff] [blame]29 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]30 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
tragaitabdff1b2021-10-06 11:04:18 +0100[diff] [blame]31 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
sourabh_sourabh1f2e66e2022-02-16 21:53:41 +0530[diff] [blame]32 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]33 responses:
34 200:
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]35 description: OK
36 content:
37 application/json:
38 schema:
39 type: object
40 examples:
41 dataSampleResponse:
42 $ref: 'components.yaml#/components/examples/dataSampleResponse'
tragaitc3285512021-08-16 15:12:36 +0100[diff] [blame]43 400:
44 $ref: 'components.yaml#/components/responses/BadRequest'
45 401:
46 $ref: 'components.yaml#/components/responses/Unauthorized'
47 403:
48 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]49 500:
50 $ref: 'components.yaml#/components/responses/InternalServerError'
tragait888dcd42021-08-19 15:17:56 +0100[diff] [blame]51
52resourceDataForPassthroughRunning:
53 get:
54 tags:
55 - network-cm-proxy
56 summary: Get resource data from pass-through running for cm handle
57 description: Get resource data from pass-through running for given cm handle
58 operationId: getResourceDataRunningForCmHandle
59 parameters:
60 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +0100[diff] [blame]61 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragait888dcd42021-08-19 15:17:56 +0100[diff] [blame]62 - $ref: 'components.yaml#/components/parameters/acceptParamInHeader'
tragaitabdff1b2021-10-06 11:04:18 +0100[diff] [blame]63 - $ref: 'components.yaml#/components/parameters/optionsParamInQuery'
sourabh_sourabh1f2e66e2022-02-16 21:53:41 +0530[diff] [blame]64 - $ref: 'components.yaml#/components/parameters/topicParamInQuery'
tragait888dcd42021-08-19 15:17:56 +0100[diff] [blame]65 responses:
66 200:
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]67 description: OK
68 content:
69 application/json:
70 schema:
71 type: object
72 examples:
73 dataSampleResponse:
74 $ref: 'components.yaml#/components/examples/dataSampleResponse'
tragait888dcd42021-08-19 15:17:56 +0100[diff] [blame]75 400:
76 $ref: 'components.yaml#/components/responses/BadRequest'
77 401:
78 $ref: 'components.yaml#/components/responses/Unauthorized'
79 403:
80 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]81 500:
82 $ref: 'components.yaml#/components/responses/InternalServerError'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]83 post:
84 tags:
85 - network-cm-proxy
86 summary: create resource data from pass-through running for cm handle
87 description: create resource data from pass-through running for given cm handle
88 operationId: createResourceDataRunningForCmHandle
89 parameters:
90 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
niamhcorefd2e6dd2021-09-29 16:43:35 +0100[diff] [blame]91 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]92 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
93 requestBody:
94 required: true
95 content:
96 application/json:
97 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]98 type: object
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]99 examples:
100 dataSampleRequest:
101 $ref: 'components.yaml#/components/examples/dataSampleRequest'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]102 application/yang-data+json:
103 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]104 type: object
105 examples:
106 dataSampleRequest:
107 $ref: 'components.yaml#/components/examples/dataSampleRequest'
tragaitc584bf22021-08-20 15:45:58 +0100[diff] [blame]108 responses:
109 201:
110 $ref: 'components.yaml#/components/responses/Created'
111 400:
112 $ref: 'components.yaml#/components/responses/BadRequest'
113 401:
114 $ref: 'components.yaml#/components/responses/Unauthorized'
115 403:
116 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]117 500:
118 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]119
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]120 put:
121 tags:
122 - network-cm-proxy
123 summary: Update resource data from pass-through running for a cm handle
124 description: Update resource data from pass-through running for the given cm handle
125 operationId: updateResourceDataRunningForCmHandle
126 parameters:
127 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
128 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
129 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
130 requestBody:
131 required: true
132 content:
133 application/json:
134 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]135 type: object
emaclee844cab32021-12-01 09:42:37 +0000[diff] [blame]136 examples:
137 dataSampleRequest:
138 $ref: 'components.yaml#/components/examples/dataSampleRequest'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]139 application/yang-data+json:
140 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]141 type: object
142 examples:
143 dataSampleRequest:
144 $ref: 'components.yaml#/components/examples/dataSampleRequest'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]145 responses:
146 200:
147 $ref: 'components.yaml#/components/responses/Ok'
148 400:
149 $ref: 'components.yaml#/components/responses/BadRequest'
150 401:
151 $ref: 'components.yaml#/components/responses/Unauthorized'
152 403:
153 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]154 500:
155 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcore919e9062021-11-02 14:08:16 +0000[diff] [blame]156
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]157 patch:
158 tags:
159 - network-cm-proxy
160 summary: Patch resource data from pass-through running
161 description: Patch resource data from pass-through running for the given cm handle
162 operationId: patchResourceDataRunningForCmHandle
163 parameters:
164 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
165 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
166 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
167 requestBody:
168 required: true
169 content:
tragaitecd7f5e2022-01-13 13:15:14 +0000[diff] [blame]170 '*/*':
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]171 schema:
172 type: object
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]173 examples:
174 dataSampleRequest:
tragaitecd7f5e2022-01-13 13:15:14 +0000[diff] [blame]175 $ref: 'components.yaml#/components/examples/dataSamplePatchRequest'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]176 responses:
177 200:
178 $ref: 'components.yaml#/components/responses/Ok'
179 400:
180 $ref: 'components.yaml#/components/responses/BadRequest'
181 401:
182 $ref: 'components.yaml#/components/responses/Unauthorized'
183 403:
184 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]185 500:
186 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcore4314e7b2021-11-24 10:53:51 +0000[diff] [blame]187
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]188 delete:
189 tags:
190 - network-cm-proxy
191 summary: Delete resource data
192 description: Delete resource data from pass-through running for a given cm handle
193 operationId: deleteResourceDataRunningForCmHandle
194 parameters:
195 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
196 - $ref: 'components.yaml#/components/parameters/resourceIdentifierInQuery'
197 - $ref: 'components.yaml#/components/parameters/contentParamInHeader'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]198 responses:
199 204:
200 $ref: 'components.yaml#/components/responses/NoContent'
201 400:
202 $ref: 'components.yaml#/components/responses/BadRequest'
203 401:
204 $ref: 'components.yaml#/components/responses/Unauthorized'
205 403:
206 $ref: 'components.yaml#/components/responses/Forbidden'
207 404:
208 $ref: 'components.yaml#/components/responses/NotFound'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]209 500:
210 $ref: 'components.yaml#/components/responses/InternalServerError'
DylanB95ESTeeef2ae2021-11-30 15:07:35 +0000[diff] [blame]211
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]212fetchModuleReferencesByCmHandle:
213 get:
214 description: fetch all module references (name and revision) for a given cm handle
215 tags:
216 - network-cm-proxy
217 summary: Fetch all module references (name and revision) for a given cm handle
218 operationId: getModuleReferencesByCmHandle
219 parameters:
220 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
221 responses:
222 200:
223 description: OK
224 content:
225 application/json:
226 schema:
puthuparambil.adityad0007332021-12-08 18:53:39 +0000[diff] [blame]227 type: array
228 items:
lukegleesond5bda882022-03-02 14:32:47 +0000[diff] [blame]229 $ref: 'components.yaml#/components/schemas/RestModuleReference'
niamhcorec309f242021-09-07 10:27:18 +0100[diff] [blame]230 400:
231 $ref: 'components.yaml#/components/responses/BadRequest'
232 401:
233 $ref: 'components.yaml#/components/responses/Unauthorized'
234 403:
235 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]236 500:
237 $ref: 'components.yaml#/components/responses/InternalServerError'
niamhcore66017b42021-10-19 11:07:02 +0100[diff] [blame]238
239executeCmHandleSearch:
240 post:
241 description: Execute cm handle searches using 'hasAllModules' condition to get all cm handles for the given module names
242 tags:
243 - network-cm-proxy
244 summary: Execute cm handle search using the available conditions
245 operationId: executeCmHandleSearch
246 requestBody:
247 required: true
248 content:
249 application/json:
250 schema:
251 $ref: 'components.yaml#/components/schemas/Conditions'
252 responses:
253 200:
254 description: OK
255 content:
256 application/json:
257 schema:
258 $ref: 'components.yaml#/components/schemas/CmHandles'
259 400:
260 $ref: 'components.yaml#/components/responses/BadRequest'
261 401:
262 $ref: 'components.yaml#/components/responses/Unauthorized'
263 403:
ToineSiebelink18a79eb2021-12-23 12:36:40 +0000[diff] [blame]264 $ref: 'components.yaml#/components/responses/Forbidden'
JosephKeenane0873dd2022-01-28 11:22:22 +0000[diff] [blame]265 500:
266 $ref: 'components.yaml#/components/responses/InternalServerError'
DylanB95ESTe5573382022-01-27 17:12:52 +0000[diff] [blame]267
268retrieveCmHandleDetailsById:
269 get:
270 description: Retrieve CM handle details and properties by cm handle id
271 tags:
272 - network-cm-proxy
273 summary: Retrieve CM handle details
274 operationId: retrieveCmHandleDetailsById
275 parameters:
276 - $ref: 'components.yaml#/components/parameters/cmHandleInPath'
277 responses:
278 200:
279 description: OK
280 content:
281 application/json:
282 schema:
283 $ref: 'components.yaml#/components/schemas/RestOutputCmHandle'
284 400:
285 $ref: 'components.yaml#/components/responses/BadRequest'
286 401:
287 $ref: 'components.yaml#/components/responses/Unauthorized'
288 403:
289 $ref: 'components.yaml#/components/responses/Forbidden'
290 404:
291 $ref: 'components.yaml#/components/responses/NotFound'
292 500:
293 $ref: 'components.yaml#/components/responses/InternalServerError'