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: onboard helm pkg (custom onboarding)
39 description: This file represents the helm chart.
42 description: successfully onboarded helmchart
44 description: helmchart onboard failed
46 $ref: '#/definitions/error_message'
56 description: Get helm chart list
60 description: Get helm chart list failed
62 $ref: '#/definitions/error_message'
65 operationId: get_charts_list
66 summary: Returns the list of xApp helm charts that have been onboarded
67 '/charts/xApp/download/{xApp_name}/ver/{version}':
82 description: Download helm chart OK
86 description: Get helm chart values.yaml failed
88 $ref: '#/definitions/error_message'
91 description: Download helm chart.
92 operationId: download_helm_chart
93 summary: Download helm chart
94 '/charts/xApp/{xApp_name}':
105 description: Get helm chart
111 description: Get helm chart failed
113 $ref: '#/definitions/error_message'
116 operationId: get_chart
117 summary: Returns the helm chart for the specified xApp
118 '/charts/xApp/{xApp_name}/ver/{version}':
134 description: Deleted specified helm chart
138 description: Delete helm chart failed
140 $ref: '#/definitions/error_message'
143 operationId: delete_chart
144 summary: Delete helm chart for the specified xApp and version
159 description: Get helm chart details OK
163 description: Get helm chart details failed
165 $ref: '#/definitions/error_message'
168 operationId: get_charts_fetcher
169 summary: get the helm chart for the specified xApp and version
170 '/charts/xApp/{xApp_name}/ver/{version}/values.yaml':
186 description: Get helm chart values.yaml OK
190 description: Get helm chart values.yaml failed
192 $ref: '#/definitions/error_message'
195 description: yaml file of the specified xApp and version.
196 operationId: get_values_yaml_fetcher
197 summary: Returns the helm values
205 - description: Input for the xApp deploy
210 $ref: '#/definitions/deleteDeploymentDesc'
213 description: successful un-deploy xApp
217 description: un-deployment failed
219 $ref: '#/definitions/error_message'
222 summary: Undeploy xApp
229 - description: Input for the xApp deployment
234 $ref: '#/definitions/deploymentDesc'
237 description: successful deployment of xApp
241 description: deployment failed
243 $ref: '#/definitions/error_message'
253 - description: Input for the xApp deploy
258 $ref: '#/definitions/updateDeploymentDesc'
261 description: successful updated xApp
265 description: un-deployment failed
267 $ref: '#/definitions/error_message'
278 description: Health check OK
280 $ref: '#/definitions/status'
282 description: ric-dms is not ready
284 $ref: '#/definitions/error_message'
287 operationId: get_health_check
288 summary: Returns the health condition of ric dms
289 '/healthcheck/xApp/{xApp_name}/namespace/{namespace}':
304 description: Health check OK
306 $ref: '#/definitions/status'
308 description: xApp onboarder is not ready
310 $ref: '#/definitions/error_message'
313 summary: Return status of xApp deployment
334 description: xApp onboard successfully.
336 $ref: '#/definitions/status'
338 description: xApp descriptor format error
340 $ref: '#/definitions/error_message'
342 description: xApp onboarder is not ready
344 $ref: '#/definitions/error_message'
347 operationId: delete_onboardx_apps
348 summary: offload xApp using the xApp name and version
349 x-codegen-request-body-name: payload
360 $ref: '#/definitions/descriptor'
363 description: xApp onboard successfully.
365 $ref: '#/definitions/status'
367 description: xApp descriptor format error
369 $ref: '#/definitions/error_message'
371 description: xApp onboarder is not ready
373 $ref: '#/definitions/error_message'
376 operationId: post_onboardx_apps
378 Onboard xApp using the xApp descriptor and schema or URL of descriptor
380 x-codegen-request-body-name: payload
382 deleteDeploymentDesc:
385 description: namespace to deploy xApp
398 description: namespace to deploy xApp
401 description: override file
413 description: represents content of config file for xApp onboarding.
416 description: specify url of config-file.
419 description: represents conent of schema file for xApp onboarding.
422 description: specify url of schema-file.
428 description: source of the error
431 description: source of the error
434 description: http response message
449 description: status of the service
454 updateDeploymentDesc:
457 description: namespace to deploy xApp
474 - description: onboard xApps
476 - description: health check
478 - description: Managing helm charts
480 - description: Managing deployment