1 # ========================LICENSE_START=================================
4 # Copyright (C) 2019 AT&T Intellectual Property and Nokia
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 # ========================LICENSE_END===================================
20 description: This is a draft API for RIC appmgr
25 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
33 summary : Health check of xApp Manager - Liveness probe
36 operationId : getHealthAlive
39 description : Status of xApp Manager is ok
42 summary : Readiness check of xApp Manager - Readiness probe
45 operationId : getHealthReady
48 description : xApp Manager is ready for service
50 description: xApp Manager is not ready for service
53 summary: Deploy a xapp
56 operationId: deployXapp
64 description: xApp information
72 description: Name of the xApp.
76 description: Name of the xApp configmap. Overrides the value given in Helm chart value file.
77 example: xapp-dummy-configmap
80 description: Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.
84 description: Name of the service xApp is providing. Overrides the value given in Helm chart value file.
85 example: xapp-dummy-service
88 description: Name of the docker repository xApp is located. Overrides the value given in Helm chart value file.
92 description: Hostname for the pod. Used by messaging library. Overrides the value given in Helm chart value file.
96 description: xApp successfully created
98 $ref: '#/definitions/Xapp'
100 description: Invalid input
102 description: Internal error
104 summary: Returns the status of all xapps
107 operationId: getAllXapps
112 description: successful query of xApps
114 $ref: '#/definitions/AllDeployedXapps'
116 description: Internal error
119 summary: Returns the list of all deployable xapps
122 operationId: listAllXapps
127 description: successful list of deployable xApps
129 $ref: '#/definitions/AllDeployableXapps'
131 description: Internal error
134 summary: Returns the status of a given xapp
137 operationId: getXappByName
143 description: Name of xApp
148 description: successful operation
150 $ref: '#/definitions/Xapp'
152 description: Invalid ID supplied
154 description: Xapp not found
156 description: Internal error
158 summary: Undeploy an existing xapp
161 operationId: undeployXapp
165 description: Xapp to be undeployed
170 description: Successful deletion of xApp
172 description: Invalid xApp name supplied
174 description: Internal error
175 '/xapps/{xAppName}/instances/{xAppInstanceName}':
177 summary: Returns the status of a given xapp
180 operationId: getXappInstanceByName
186 description: Name of xApp
189 - name: xAppInstanceName
191 description: Name of xApp instance to get information
196 description: successful operation
198 $ref: '#/definitions/XappInstance'
200 description: Invalid name supplied
202 description: Xapp not found
204 description: Internal error
207 summary: Create xApp config
210 operationId: createXappConfig
218 description: xApp config
220 $ref: '#/definitions/XAppConfig'
223 description: xApp config successfully created
225 $ref: '#/definitions/XAppConfig'
227 description: Invalid input
229 description: Validation of configuration failed
231 description: Internal error
233 summary: Modify xApp config
236 operationId: ModifyXappConfig
244 description: xApp config
246 $ref: '#/definitions/XAppConfig'
249 description: xApp config successfully modified
251 $ref: '#/definitions/XAppConfig'
253 description: Invalid input
255 description: Validation of configuration failed
257 description: Internal error
259 summary: Returns the configuration of all xapps
262 operationId: getAllXappConfig
267 description: successful query of xApp config
269 $ref: '#/definitions/AllXappConfig'
271 description: Internal error
273 summary: Delete xApp configuration
276 operationId: deleteXappConfig
278 - name: ConfigMetadata
280 description: xApp configuration information
282 $ref: '#/definitions/ConfigMetadata'
285 description: Successful deletion of xApp
287 description: Invalid parameters supplied
289 description: Internal error
292 summary: Subscribe event
296 operationId: addSubscription
302 - name: subscriptionRequest
304 description: New subscription
307 $ref: '#/definitions/subscriptionRequest'
310 description: Subscription successful
312 $ref: '#/definitions/subscriptionResponse'
314 description: Invalid input
316 summary: Returns all subscriptions
320 operationId: getSubscriptions
325 description: successful query of subscriptions
327 $ref: '#/definitions/allSubscriptions'
328 '/subscriptions/{subscriptionId}':
330 summary: Returns the information of subscription
334 operationId: getSubscriptionById
338 - name: subscriptionId
340 description: ID of subscription
345 description: successful operation
347 $ref: '#/definitions/subscription'
349 description: Invalid ID supplied
351 description: Subscription not found
353 summary: Modify event subscription
357 operationId: modifySubscription
363 - name: subscriptionId
365 description: ID of subscription
369 name: subscriptionRequest
370 description: Modified subscription
373 $ref: '#/definitions/subscriptionRequest'
376 description: Subscription modification successful
378 $ref: '#/definitions/subscriptionResponse'
380 description: Invalid input
382 summary: Unsubscribe event
387 operationId: deleteSubscription
389 - name: subscriptionId
391 description: ID of subscription
396 description: Successful deletion of subscription
398 description: Invalid subscription supplied
404 example: "xapp-dummy"
408 $ref: '#/definitions/Xapp'
419 description: xapp status in the RIC
433 $ref: '#/definitions/XappInstance'
441 example: xapp-dummy-6cd577d9-4v255
444 description: xapp instance status
463 example: ControlIndication
468 example: LoadIndication
478 description: Name of the xApp
482 description: Name of the config map
483 example: xapp-dummy-config-map
486 description: Name of the namespace
496 $ref: '#/definitions/ConfigMetadata'
499 description: Schema of configuration in JSON format
502 description: Configuration in JSON format
506 $ref: '#/definitions/XAppConfig'
517 example: 'http://localhost:11111/apps/webhook/'
520 description: Event which is subscribed
527 description: Maximum number of retries
531 description: Time in seconds to wait before next retry
533 subscriptionResponse:
538 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
544 description: Event which is subscribed
553 $ref: '#/definitions/subscription'
559 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
562 example: 'http://localhost:11111/apps/webhook/'
565 description: Event which is subscribed
573 description: Maximum number of retries
577 description: Time in seconds to wait before next retry
579 subscriptionNotification:
584 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
590 description: Event to be notified
596 $ref: '#/definitions/AllDeployedXapps'