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
32 summary: upload a file
39 description: api to upload file
42 description: successfully uploaded
52 description: Get helm chart list
56 description: Get helm chart list failed
58 $ref: '#/definitions/error_message'
61 operationId: get_charts_list
62 summary: Returns the list of xApp helm charts that have been onboarded
63 '/charts/xApp/download/{xApp_name}/ver/{version}':
78 description: Download helm chart OK
82 description: Get helm chart values.yaml failed
84 $ref: '#/definitions/error_message'
87 description: Download helm chart.
88 operationId: download_helm_chart
89 summary: Download helm chart
90 '/charts/xApp/{xApp_name}':
101 description: Get helm chart
107 description: Get helm chart failed
109 $ref: '#/definitions/error_message'
112 operationId: get_chart
113 summary: Returns the helm chart for the specified xApp
114 '/charts/xApp/{xApp_name}/ver/{version}':
130 description: Deleted specified helm chart
134 description: Delete helm chart failed
136 $ref: '#/definitions/error_message'
139 operationId: delete_chart
140 summary: Delete helm chart for the specified xApp and version
155 description: Get helm chart details OK
159 description: Get helm chart details failed
161 $ref: '#/definitions/error_message'
164 operationId: get_charts_fetcher
165 summary: get the helm chart for the specified xApp and version
166 '/charts/xApp/{xApp_name}/ver/{version}/values.yaml':
182 description: Get helm chart values.yaml OK
186 description: Get helm chart values.yaml failed
188 $ref: '#/definitions/error_message'
191 description: yaml file of the specified xApp and version.
192 operationId: get_values_yaml_fetcher
193 summary: Returns the helm values
201 - description: Input for the xApp deploy
206 $ref: '#/definitions/deleteDeploymentDesc'
209 description: successful un-deploy xApp
213 description: un-deployment failed
215 $ref: '#/definitions/error_message'
218 summary: Undeploy xApp
225 - description: Input for the xApp deployment
230 $ref: '#/definitions/deploymentDesc'
233 description: successful deployment of xApp
237 description: deployment failed
239 $ref: '#/definitions/error_message'
249 - description: Input for the xApp deploy
254 $ref: '#/definitions/updateDeploymentDesc'
257 description: successful updated xApp
261 description: un-deployment failed
263 $ref: '#/definitions/error_message'
274 description: Health check OK
276 $ref: '#/definitions/status'
278 description: ric-dms is not ready
280 $ref: '#/definitions/error_message'
283 operationId: get_health_check
284 summary: Returns the health condition of ric dms
285 '/healthcheck/xApp/{xApp_name}/namespace/{namespace}':
300 description: Health check OK
302 $ref: '#/definitions/status'
304 description: xApp onboarder is not ready
306 $ref: '#/definitions/error_message'
309 summary: Return status of xApp deployment
330 description: xApp onboard successfully.
332 $ref: '#/definitions/status'
334 description: xApp descriptor format error
336 $ref: '#/definitions/error_message'
338 description: xApp onboarder is not ready
340 $ref: '#/definitions/error_message'
343 operationId: delete_onboardx_apps
344 summary: offload xApp using the xApp name and version
345 x-codegen-request-body-name: payload
356 $ref: '#/definitions/descriptor'
359 description: xApp onboard successfully.
361 $ref: '#/definitions/status'
363 description: xApp descriptor format error
365 $ref: '#/definitions/error_message'
367 description: xApp onboarder is not ready
369 $ref: '#/definitions/error_message'
372 operationId: post_onboardx_apps
374 Onboard xApp using the xApp descriptor and schema or URL of descriptor
376 x-codegen-request-body-name: payload
378 deleteDeploymentDesc:
381 description: namespace to deploy xApp
394 description: namespace to deploy xApp
397 description: override file
409 description: represents content of config file for xApp onboarding.
412 description: specify url of config-file.
415 description: represents conent of schema file for xApp onboarding.
418 description: specify url of schema-file.
424 description: source of the error
427 description: source of the error
430 description: http response message
445 description: status of the service
450 updateDeploymentDesc:
453 description: namespace to deploy xApp
470 - description: onboard xApps
472 - description: health check
474 - description: Managing helm charts
476 - description: Managing deployment