1 # ==================================================================================
2 # Copyright (c) 2021 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 # ==================================================================================
23 description: APIs for RIC-DMS
29 description: onboard xApps
31 description: health check
33 description: Managing helm charts
35 description: Managing deployment
41 summary: Returns the list of xApp helm charts that have been onboarded
42 operationId: get_charts_list
45 description: Get helm chart list
51 description: Get helm chart list failed
55 $ref: '#/components/schemas/error_message'
57 /charts/xApp/{xApp_name}:
61 summary: Returns the helm chart for the specified xApp
62 operationId: get_chart
71 description: Get helm chart
77 description: Get helm chart failed
81 $ref: '#/components/schemas/error_message'
83 /charts/xApp/{xApp_name}/ver/{version}:
87 summary: get the helm chart for the specified xApp and version
88 operationId: get_charts_fetcher
102 description: Get helm chart package OK
108 description: Get helm chart package failed
112 $ref: '#/components/schemas/error_message'
116 summary: Delete helm chart for the specified xApp and version
117 operationId: delete_chart
131 description: Deleted specified helm chart
137 description: Delete helm chart failed
141 $ref: '#/components/schemas/error_message'
143 /charts/xApp/download/{xApp_name}/ver/{version}:
147 summary: Download helm chart
148 description: Download helm chart.
149 operationId: download_helm_chart
163 description: Download helm chart OK
170 description: Get helm chart values.yaml failed
174 $ref: '#/components/schemas/error_message'
176 /charts/xApp/{xApp_name}/ver/{version}/values.yaml:
180 summary: Returns the helm values
181 description: yaml file of the specified xApp and version.
182 operationId: get_values_yaml_fetcher
196 description: Get helm chart values.yaml OK
202 description: Get helm chart values.yaml failed
206 $ref: '#/components/schemas/error_message'
212 summary: Returns the health condition of ric dms
213 operationId: get_health_check
216 description: Health check OK
220 $ref: '#/components/schemas/status'
222 description: ric-dms is not ready
226 $ref: '#/components/schemas/error_message'
228 /healthcheck/xApp/{xApp_name}/namespace/{namespace}:
232 summary: Return status of xApp deployment
246 description: Health check OK
250 $ref: '#/components/schemas/status'
252 description: xApp onboarder is not ready
256 $ref: '#/components/schemas/error_message'
262 summary: Onboard xApp using the xApp descriptor and schema or URL of descriptor and schema.
263 operationId: post_onboardx_apps
268 $ref: '#/components/schemas/descriptor'
272 description: xApp onboard successfully.
276 $ref: '#/components/schemas/status'
278 description: xApp descriptor format error
282 $ref: '#/components/schemas/error_message'
284 description: xApp onboarder is not ready
288 $ref: '#/components/schemas/error_message'
289 x-codegen-request-body-name: payload
293 summary: offload xApp using the xApp name and version
294 operationId: delete_onboardx_apps
309 description: xApp onboard successfully.
313 $ref: '#/components/schemas/status'
315 description: xApp descriptor format error
319 $ref: '#/components/schemas/error_message'
321 description: xApp onboarder is not ready
325 $ref: '#/components/schemas/error_message'
326 x-codegen-request-body-name: payload
334 description: Input for the xApp deployment
339 $ref: '#/components/schemas/deploymentDesc'
342 description: successful deployment of xApp
348 description: deployment failed
352 $ref: '#/components/schemas/error_message'
359 description: Input for the xApp deploy
364 $ref: '#/components/schemas/updateDeploymentDesc'
368 description: successful updated xApp
374 description: un-deployment failed
378 $ref: '#/components/schemas/error_message'
382 summary: Undeploy xApp
384 description: Input for the xApp deploy
389 $ref: '#/components/schemas/deleteDeploymentDesc'
392 description: successful un-deploy xApp
398 description: un-deployment failed
402 $ref: '#/components/schemas/error_message'
418 description: represents content of config file for xApp onboarding.
421 description: represents conent of schema file for xApp onboarding.
424 description: specify url of config-file.
427 description: specify url of schema-file.
440 description: namespace to deploy xApp
443 description: override file
445 updateDeploymentDesc:
458 description: namespace to deploy xApp
465 deleteDeploymentDesc:
477 description: namespace to deploy xApp
488 description: source of the error
491 description: source of the error
494 description: http response message
502 description: status of the service