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}':
63 description: Download helm chart OK
67 description: Get helm chart values.yaml failed
69 $ref: '#/definitions/error_message'
72 description: Download helm chart.
73 operationId: download_helm_chart
74 summary: Download helm chart
75 '/charts/xApp/{xApp_name}':
86 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
140 description: Get helm chart details OK
144 description: Get helm chart details failed
146 $ref: '#/definitions/error_message'
149 operationId: get_charts_fetcher
150 summary: get the helm chart for the specified xApp and version
151 '/charts/xApp/{xApp_name}/ver/{version}/values.yaml':
167 description: Get helm chart values.yaml OK
171 description: Get helm chart values.yaml failed
173 $ref: '#/definitions/error_message'
176 description: yaml file of the specified xApp and version.
177 operationId: get_values_yaml_fetcher
178 summary: Returns the helm values
186 - description: Input for the xApp deploy
191 $ref: '#/definitions/deleteDeploymentDesc'
194 description: successful un-deploy xApp
198 description: un-deployment failed
200 $ref: '#/definitions/error_message'
203 summary: Undeploy xApp
210 - description: Input for the xApp deployment
215 $ref: '#/definitions/deploymentDesc'
218 description: successful deployment of xApp
222 description: deployment failed
224 $ref: '#/definitions/error_message'
234 - description: Input for the xApp deploy
239 $ref: '#/definitions/updateDeploymentDesc'
242 description: successful updated xApp
246 description: un-deployment failed
248 $ref: '#/definitions/error_message'
259 description: Health check OK
261 $ref: '#/definitions/status'
263 description: ric-dms is not ready
265 $ref: '#/definitions/error_message'
268 operationId: get_health_check
269 summary: Returns the health condition of ric dms
270 '/healthcheck/xApp/{xApp_name}/namespace/{namespace}':
285 description: Health check OK
287 $ref: '#/definitions/status'
289 description: xApp onboarder is not ready
291 $ref: '#/definitions/error_message'
294 summary: Return status of xApp deployment
315 description: xApp onboard successfully.
317 $ref: '#/definitions/status'
319 description: xApp descriptor format error
321 $ref: '#/definitions/error_message'
323 description: xApp onboarder is not ready
325 $ref: '#/definitions/error_message'
328 operationId: delete_onboardx_apps
329 summary: offload xApp using the xApp name and version
330 x-codegen-request-body-name: payload
341 $ref: '#/definitions/descriptor'
344 description: xApp onboard successfully.
346 $ref: '#/definitions/status'
348 description: xApp descriptor format error
350 $ref: '#/definitions/error_message'
352 description: xApp onboarder is not ready
354 $ref: '#/definitions/error_message'
357 operationId: post_onboardx_apps
359 Onboard xApp using the xApp descriptor and schema or URL of descriptor
361 x-codegen-request-body-name: payload
363 deleteDeploymentDesc:
366 description: namespace to deploy xApp
379 description: namespace to deploy xApp
382 description: override file
394 description: represents content of config file for xApp onboarding.
397 description: specify url of config-file.
400 description: represents conent of schema file for xApp onboarding.
403 description: specify url of schema-file.
409 description: source of the error
412 description: source of the error
415 description: http response message
430 description: status of the service
435 updateDeploymentDesc:
438 description: namespace to deploy xApp
455 - description: onboard xApps
457 - description: health check
459 - description: Managing helm charts
461 - description: Managing deployment