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