1 # ==================================================================================
2 # Copyright (c) 2022 Samsung.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
16 # This source code is part of the near-RT RIC (RAN Intelligent Controller)
17 # platform project (RICP).
18 # ==================================================================================
22 description: APIs for RIC-DMS
37 description: Get helm chart list
41 description: Get helm chart list failed
43 $ref: '#/definitions/error_message'
46 operationId: get_charts_list
47 summary: Returns the list of xApp helm charts that have been onboarded
48 '/charts/xApp/download/{xApp_name}/ver/{version}':
64 description: Download helm chart OK
69 description: Get helm chart values.yaml failed
71 $ref: '#/definitions/error_message'
74 description: Download helm chart.
75 operationId: download_helm_chart
76 summary: Download helm chart
77 '/charts/xApp/{xApp_name}':
88 description: Get helm chart
92 description: Get helm chart failed
94 $ref: '#/definitions/error_message'
97 operationId: get_chart
98 summary: Returns the helm chart for the specified xApp
99 '/charts/xApp/{xApp_name}/ver/{version}':
115 description: Deleted specified helm chart
119 description: Delete helm chart failed
121 $ref: '#/definitions/error_message'
124 operationId: delete_chart
125 summary: Delete helm chart for the specified xApp and version
141 description: Get helm chart package OK
145 description: Get helm chart package failed
147 $ref: '#/definitions/error_message'
150 operationId: get_charts_fetcher
151 summary: get the helm chart for the specified xApp and version
152 '/charts/xApp/{xApp_name}/ver/{version}/values.yaml':
168 description: Get helm chart values.yaml OK
172 description: Get helm chart values.yaml failed
174 $ref: '#/definitions/error_message'
177 description: yaml file of the specified xApp and version.
178 operationId: get_values_yaml_fetcher
179 summary: Returns the helm values
187 - description: Input for the xApp deploy
192 $ref: '#/definitions/deleteDeploymentDesc'
195 description: successful un-deploy xApp
199 description: un-deployment failed
201 $ref: '#/definitions/error_message'
204 summary: Undeploy xApp
211 - description: Input for the xApp deployment
216 $ref: '#/definitions/deploymentDesc'
219 description: successful deployment of xApp
223 description: deployment failed
225 $ref: '#/definitions/error_message'
235 - description: Input for the xApp deploy
240 $ref: '#/definitions/updateDeploymentDesc'
243 description: successful updated xApp
247 description: un-deployment failed
249 $ref: '#/definitions/error_message'
260 description: Health check OK
262 $ref: '#/definitions/status'
264 description: ric-dms is not ready
266 $ref: '#/definitions/error_message'
269 operationId: get_health_check
270 summary: Returns the health condition of ric dms
271 '/healthcheck/xApp/{xApp_name}/namespace/{namespace}':
286 description: Health check OK
288 $ref: '#/definitions/status'
290 description: xApp onboarder is not ready
292 $ref: '#/definitions/error_message'
295 summary: Return status of xApp deployment
316 description: xApp onboard successfully.
318 $ref: '#/definitions/status'
320 description: xApp descriptor format error
322 $ref: '#/definitions/error_message'
324 description: xApp onboarder is not ready
326 $ref: '#/definitions/error_message'
329 operationId: delete_onboardx_apps
330 summary: offload xApp using the xApp name and version
331 x-codegen-request-body-name: payload
342 $ref: '#/definitions/descriptor'
345 description: xApp onboard successfully.
347 $ref: '#/definitions/status'
349 description: xApp descriptor format error
351 $ref: '#/definitions/error_message'
353 description: xApp onboarder is not ready
355 $ref: '#/definitions/error_message'
358 operationId: post_onboardx_apps
360 Onboard xApp using the xApp descriptor and schema or URL of descriptor
362 x-codegen-request-body-name: payload
364 deleteDeploymentDesc:
367 description: namespace to deploy xApp
380 description: namespace to deploy xApp
383 description: override file
395 description: represents content of config file for xApp onboarding.
398 description: specify url of config-file.
401 description: represents conent of schema file for xApp onboarding.
404 description: specify url of schema-file.
410 description: source of the error
413 description: source of the error
416 description: http response message
431 description: status of the service
436 updateDeploymentDesc:
439 description: namespace to deploy xApp
456 - description: onboard xApps
458 - description: health check
460 - description: Managing helm charts
462 - description: Managing deployment