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
94 description: Get helm chart failed
96 $ref: '#/definitions/error_message'
99 operationId: get_chart
100 summary: Returns the helm chart for the specified xApp
101 '/charts/xApp/{xApp_name}/ver/{version}':
117 description: Deleted specified helm chart
121 description: Delete helm chart failed
123 $ref: '#/definitions/error_message'
126 operationId: delete_chart
127 summary: Delete helm chart for the specified xApp and version
143 description: Get helm chart package OK
147 description: Get helm chart package failed
149 $ref: '#/definitions/error_message'
152 operationId: get_charts_fetcher
153 summary: get the helm chart for the specified xApp and version
154 '/charts/xApp/{xApp_name}/ver/{version}/values.yaml':
170 description: Get helm chart values.yaml OK
174 description: Get helm chart values.yaml failed
176 $ref: '#/definitions/error_message'
179 description: yaml file of the specified xApp and version.
180 operationId: get_values_yaml_fetcher
181 summary: Returns the helm values
189 - description: Input for the xApp deploy
194 $ref: '#/definitions/deleteDeploymentDesc'
197 description: successful un-deploy xApp
201 description: un-deployment failed
203 $ref: '#/definitions/error_message'
206 summary: Undeploy xApp
213 - description: Input for the xApp deployment
218 $ref: '#/definitions/deploymentDesc'
221 description: successful deployment of xApp
225 description: deployment failed
227 $ref: '#/definitions/error_message'
237 - description: Input for the xApp deploy
242 $ref: '#/definitions/updateDeploymentDesc'
245 description: successful updated xApp
249 description: un-deployment failed
251 $ref: '#/definitions/error_message'
262 description: Health check OK
264 $ref: '#/definitions/status'
266 description: ric-dms is not ready
268 $ref: '#/definitions/error_message'
271 operationId: get_health_check
272 summary: Returns the health condition of ric dms
273 '/healthcheck/xApp/{xApp_name}/namespace/{namespace}':
288 description: Health check OK
290 $ref: '#/definitions/status'
292 description: xApp onboarder is not ready
294 $ref: '#/definitions/error_message'
297 summary: Return status of xApp deployment
318 description: xApp onboard successfully.
320 $ref: '#/definitions/status'
322 description: xApp descriptor format error
324 $ref: '#/definitions/error_message'
326 description: xApp onboarder is not ready
328 $ref: '#/definitions/error_message'
331 operationId: delete_onboardx_apps
332 summary: offload xApp using the xApp name and version
333 x-codegen-request-body-name: payload
344 $ref: '#/definitions/descriptor'
347 description: xApp onboard successfully.
349 $ref: '#/definitions/status'
351 description: xApp descriptor format error
353 $ref: '#/definitions/error_message'
355 description: xApp onboarder is not ready
357 $ref: '#/definitions/error_message'
360 operationId: post_onboardx_apps
362 Onboard xApp using the xApp descriptor and schema or URL of descriptor
364 x-codegen-request-body-name: payload
366 deleteDeploymentDesc:
369 description: namespace to deploy xApp
382 description: namespace to deploy xApp
385 description: override file
397 description: represents content of config file for xApp onboarding.
400 description: specify url of config-file.
403 description: represents conent of schema file for xApp onboarding.
406 description: specify url of schema-file.
412 description: source of the error
415 description: source of the error
418 description: http response message
433 description: status of the service
438 updateDeploymentDesc:
441 description: namespace to deploy xApp
458 - description: onboard xApps
460 - description: health check
462 - description: Managing helm charts
464 - description: Managing deployment