Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / portal / nonrtric-controlpanel / ecf6209f1f46688e14f14b1000136d94ff6898f4 / . / docs / api.json
blob: a4ea2edf8480c54d677bb3c809d6794d5a806243 [file] [log] [blame]
PatrikBuhr79210b32020-12-14 13:45:16 +0100[diff] [blame]1{
2 "swagger": "2.0",
3 "info": {
4 "description": "Proxies access to Near-RT RIC.",
5 "version": "version not available",
6 "title": "Non-RT RIC Control Panel backend",
7 "termsOfService": "Terms of service",
8 "contact": {
9 "name": "Non-RT RIC Control Panel Dev Team",
10 "url": "http://no-docs-yet.org/",
11 "email": "noreply@O-RAN-SC.org"
12 },
13 "license": {
14 "name": "Apache 2.0 License",
15 "url": "http://www.apache.org/licenses/LICENSE-2.0"
16 }
17 },
18 "basePath": "/",
19 "tags": [
20 {
21 "name": "enrichment-controller",
22 "description": "Enrichment Controller"
23 },
24 {
25 "name": "html-5-paths-controller",
26 "description": "Html 5 Paths Controller"
27 },
28 {
29 "name": "policy-controller",
30 "description": "Policy Controller"
31 }
32 ],
33 "paths": {
34 "/api/enrichment/eijobs": {
35 "get": {
36 "tags": [
37 "enrichment-controller"
38 ],
39 "summary": "Get the EI job definitions for one EI producer",
40 "operationId": "getEiJobsUsingGET",
41 "produces": [
42 "application/json"
43 ],
44 "responses": {
45 "200": {
46 "description": "OK",
47 "schema": {
ecaiyanlinux8d398eb2021-01-13 21:59:35 +0100[diff] [blame]48 "type": "string"
PatrikBuhr79210b32020-12-14 13:45:16 +0100[diff] [blame]49 }
50 },
51 "401": {
52 "description": "Unauthorized"
53 },
54 "403": {
55 "description": "Forbidden"
56 },
57 "404": {
58 "description": "Not Found"
59 }
60 },
61 "deprecated": false
62 }
63 },
64 "/api/enrichment/eiproducers": {
65 "get": {
66 "tags": [
67 "enrichment-controller"
68 ],
69 "summary": "Get EI producers",
70 "operationId": "getEiProducersUsingGET",
71 "produces": [
72 "application/json"
73 ],
74 "responses": {
75 "200": {
76 "description": "OK",
77 "schema": {
ecaiyanlinux8d398eb2021-01-13 21:59:35 +0100[diff] [blame]78 "type": "string"
PatrikBuhr79210b32020-12-14 13:45:16 +0100[diff] [blame]79 }
80 },
81 "401": {
82 "description": "Unauthorized"
83 },
84 "403": {
85 "description": "Forbidden"
86 },
87 "404": {
88 "description": "Not Found"
89 }
90 },
91 "deprecated": false
92 }
93 },
94 "/api/policy/policies": {
95 "get": {
96 "tags": [
97 "policy-controller"
98 ],
99 "summary": "Returns the policy instances for the given policy type.",
100 "operationId": "getPolicyInstancesUsingGET",
101 "produces": [
102 "application/json"
103 ],
104 "parameters": [
105 {
106 "name": "type",
107 "in": "query",
108 "description": "type",
109 "required": true,
110 "type": "string"
111 }
112 ],
113 "responses": {
114 "200": {
115 "description": "OK",
116 "schema": {
117 "type": "string"
118 }
119 },
120 "401": {
121 "description": "Unauthorized"
122 },
123 "403": {
124 "description": "Forbidden"
125 },
126 "404": {
127 "description": "Not Found"
128 }
129 },
130 "deprecated": false
131 }
132 },
133 "/api/policy/policies/{policy_instance_id}": {
134 "get": {
135 "tags": [
136 "policy-controller"
137 ],
ecaiyanlinux6c32d752021-01-04 22:13:48 +0100[diff] [blame]138 "summary": "Returns a policy instance",
PatrikBuhr79210b32020-12-14 13:45:16 +0100[diff] [blame]139 "operationId": "getPolicyInstanceUsingGET",
140 "produces": [
141 "application/json"
142 ],
143 "parameters": [
144 {
145 "name": "policy_instance_id",
146 "in": "path",
147 "description": "policy_instance_id",
148 "required": true,
149 "type": "string"
PatrikBuhr79210b32020-12-14 13:45:16 +0100[diff] [blame]150 }
151 ],
152 "responses": {
153 "200": {
154 "description": "OK",
155 "schema": {
156 "type": "object"
157 }
158 },
159 "401": {
160 "description": "Unauthorized"
161 },
162 "403": {
163 "description": "Forbidden"
164 },
165 "404": {
166 "description": "Not Found"
167 }
168 },
169 "deprecated": false
170 },
171 "put": {
172 "tags": [
173 "policy-controller"
174 ],
175 "summary": "Creates the policy instances for the given policy type.",
176 "operationId": "putPolicyInstanceUsingPUT",
177 "consumes": [
178 "application/json"
179 ],
180 "produces": [
181 "application/json"
182 ],
183 "parameters": [
184 {
185 "in": "body",
186 "name": "instance",
187 "description": "instance",
188 "required": true,
189 "schema": {
190 "type": "string"
191 }
192 },
193 {
194 "name": "policy_instance_id",
195 "in": "path",
196 "description": "policy_instance_id",
197 "required": true,
198 "type": "string"
199 },
200 {
201 "name": "ric",
202 "in": "query",
203 "description": "ric",
204 "required": true,
205 "type": "string"
206 },
207 {
208 "name": "type",
209 "in": "query",
210 "description": "type",
211 "required": true,
212 "type": "string"
213 }
214 ],
215 "responses": {
216 "200": {
217 "description": "OK",
218 "schema": {
219 "type": "string"
220 }
221 },
222 "201": {
223 "description": "Created"
224 },
225 "401": {
226 "description": "Unauthorized"
227 },
228 "403": {
229 "description": "Forbidden"
230 },
231 "404": {
232 "description": "Not Found"
233 }
234 },
235 "deprecated": false
236 },
237 "delete": {
238 "tags": [
239 "policy-controller"
240 ],
241 "summary": "Deletes the policy instances for the given policy type.",
242 "operationId": "deletePolicyInstanceUsingDELETE",
243 "produces": [
244 "application/json"
245 ],
246 "parameters": [
247 {
248 "name": "policy_instance_id",
249 "in": "path",
250 "description": "policy_instance_id",
251 "required": true,
252 "type": "string"
253 },
254 {
255 "name": "type",
256 "in": "query",
257 "description": "type",
258 "required": true,
259 "type": "string"
260 }
261 ],
262 "responses": {
263 "200": {
264 "description": "OK",
265 "schema": {
266 "type": "string"
267 }
268 },
269 "204": {
270 "description": "No Content"
271 },
272 "401": {
273 "description": "Unauthorized"
274 },
275 "403": {
276 "description": "Forbidden"
277 }
278 },
279 "deprecated": false
280 }
281 },
282 "/api/policy/policytypes": {
283 "get": {
284 "tags": [
285 "policy-controller"
286 ],
287 "summary": "Gets the policy types from Near-RT RIC",
288 "operationId": "getAllPolicyTypesUsingGET",
289 "produces": [
290 "application/json"
291 ],
292 "responses": {
293 "200": {
294 "description": "OK",
295 "schema": {
296 "type": "string"
297 }
298 },
299 "401": {
300 "description": "Unauthorized"
301 },
302 "403": {
303 "description": "Forbidden"
304 },
305 "404": {
306 "description": "Not Found"
307 }
308 },
309 "deprecated": false
310 }
311 },
312 "/api/policy/rics": {
313 "get": {
314 "tags": [
315 "policy-controller"
316 ],
317 "summary": "Returns the rics supporting the given policy type.",
318 "operationId": "getRicsSupportingTypeUsingGET",
319 "produces": [
320 "application/json"
321 ],
322 "parameters": [
323 {
324 "name": "policyType",
325 "in": "query",
326 "description": "policyType",
327 "required": true,
328 "type": "string"
329 }
330 ],
331 "responses": {
332 "200": {
333 "description": "OK",
334 "schema": {
335 "type": "string"
336 }
337 },
338 "401": {
339 "description": "Unauthorized"
340 },
341 "403": {
342 "description": "Forbidden"
343 },
344 "404": {
345 "description": "Not Found"
346 }
347 },
348 "deprecated": false
349 }
350 },
351 "/policy": {
352 "get": {
353 "tags": [
354 "html-5-paths-controller"
355 ],
356 "summary": "forwardAngularRoutes",
357 "operationId": "forwardAngularRoutesUsingGET",
358 "produces": [
359 "*/*"
360 ],
361 "responses": {
362 "200": {
363 "description": "OK"
364 },
365 "401": {
366 "description": "Unauthorized"
367 },
368 "403": {
369 "description": "Forbidden"
370 },
371 "404": {
372 "description": "Not Found"
373 }
374 },
375 "deprecated": false
376 }
377 }
PatrikBuhr79210b32020-12-14 13:45:16 +0100[diff] [blame]378 }
379}