1 # ==================================================================================
2 # Copyright (c) 2020 AT&T Intellectual Property.
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.
15 # ==================================================================================
18 title: RIC xApp onboarder API
19 description: APIs to manage the xApp helm charts
25 description: onboard xApps
27 description: health check
29 description: Managing helm charts
35 summary: Returns the list of xApp helm charts that have been onboarded
36 operationId: get_charts_list
39 description: Get helm chart list OK
45 description: Get helm chart list failed
49 $ref: '#/components/schemas/error_message'
51 /charts/xapp/{xapp_chart_name}:
55 summary: Returns the helm chart for the specified xApp
56 operationId: get_version_list
58 - name: xapp_chart_name
65 description: Get helm chart OK
71 description: Get helm chart failed
75 $ref: '#/components/schemas/error_message'
77 /charts/xapp/{xapp_chart_name}/ver/{version}:
81 summary: Returns the helm chart for the specified xApp and version
82 operationId: get_charts_fetcher
84 - name: xapp_chart_name
96 description: Get helm chart package OK
102 description: Get helm chart package failed
106 $ref: '#/components/schemas/error_message'
108 /charts/xapp/{xapp_chart_name}/ver/{version}/values.yaml:
112 summary: Returns the helm values
113 description: yaml file of the specified xApp and version.
114 operationId: get_values_yaml_fetcher
116 - name: xapp_chart_name
128 description: Get helm chart values.yaml OK
134 description: Get helm chart values.yaml failed
138 $ref: '#/components/schemas/error_message'
144 summary: Returns the health condition of the xApp onboarder
145 operationId: get_health_check
148 description: Health check OK
152 $ref: '#/components/schemas/status'
154 description: xApp onboarder is not ready
158 $ref: '#/components/schemas/error_message'
164 summary: Onboard xApp using the xApp descriptor and schema in the request body
165 operationId: post_onboardx_apps
170 $ref: '#/components/schemas/descriptor'
174 description: xApp onboard successfully.
178 $ref: '#/components/schemas/status'
180 description: xApp descriptor format error
184 $ref: '#/components/schemas/error_message'
186 description: xApp onboarder is not ready
190 $ref: '#/components/schemas/error_message'
191 x-codegen-request-body-name: payload
197 summary: Onboard xApp after downloading the xApp descriptor and schema from
199 operationId: post_onboardx_apps_download
204 $ref: '#/components/schemas/descriptor_remote'
208 description: xApp onboard successfully.
212 $ref: '#/components/schemas/status'
214 description: xApp descriptor format error
218 $ref: '#/components/schemas/error_message'
220 description: xApp onboarder is not ready
224 $ref: '#/components/schemas/error_message'
225 x-codegen-request-body-name: payload
235 $ref: '#/components/schemas/config'
236 controls-schema.json:
239 description: Controls schema file body
248 description: Name of the xApp chart
250 pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
252 description: Version of the xApp chart
262 description: source of the error
265 description: source of the error
268 description: http response message
276 description: status of the service
279 - config-file.json_url
282 config-file.json_url:
284 description: URL to download the config-file.json file
285 controls-schema.json_url:
287 description: URL to download the controls schema.json file
290 description: When any error occurs on mask
296 description: When a mask can't be parsed