3 description: This is a draft API for RIC appmgr
8 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
17 summary : Health check of xApp Manager - Liveness probe
20 operationId : getHealthAlive
23 description : Status of xApp Manager is ok
26 summary : Readiness check of xApp Manager - Readiness probe
29 operationId : getHealthReady
32 description : xApp Manager is ready for service
34 description: xApp Manager is not ready for service
37 summary: Deploy a xapp
40 operationId: deployXapp
48 description: xApp information
56 description: Name of the xApp.
60 description: Name of the xApp configmap. Overrides the value given in Helm chart value file.
61 example: xapp-dummy-configmap
64 description: Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.
68 description: Name of the service xApp is providing. Overrides the value given in Helm chart value file.
69 example: xapp-dummy-service
72 description: Name of the docker repository xApp is located. Overrides the value given in Helm chart value file.
76 description: Hostname for the pod. Used by messaging library. Overrides the value given in Helm chart value file.
80 description: xApp successfully created
82 $ref: '#/definitions/Xapp'
84 description: Invalid input
86 description: Internal error
88 summary: Returns the status of all xapps
91 operationId: getAllXapps
96 description: successful query of xApps
98 $ref: '#/definitions/AllXapps'
100 description: Internal error
103 summary: Returns the status of a given xapp
106 operationId: getXappByName
112 description: Name of xApp
117 description: successful operation
119 $ref: '#/definitions/Xapp'
121 description: Invalid ID supplied
123 description: Xapp not found
125 description: Internal error
127 summary: Undeploy an existing xapp
130 operationId: undeployXapp
134 description: Xapp to be undeployed
139 description: Successful deletion of xApp
141 description: Invalid xApp name supplied
143 description: Internal error
144 '/xapps/{xAppName}/instances/{xAppInstanceName}':
146 summary: Returns the status of a given xapp
149 operationId: getXappInstanceByName
155 description: Name of xApp
158 - name: xAppInstanceName
160 description: Name of xApp instance to get information
165 description: successful operation
167 $ref: '#/definitions/XappInstance'
169 description: Invalid name supplied
171 description: Xapp not found
173 description: Internal error
176 summary: Create xApp config
179 operationId: createXappConfig
187 description: xApp config
189 $ref: '#/definitions/XAppConfig'
192 description: xApp config successfully created
194 $ref: '#/definitions/XAppConfig'
196 description: Invalid input
198 description: Validation of configuration failed
200 description: Internal error
202 summary: Modify xApp config
205 operationId: ModifyXappConfig
213 description: xApp config
215 $ref: '#/definitions/XAppConfig'
218 description: xApp config successfully modified
220 $ref: '#/definitions/XAppConfig'
222 description: Invalid input
224 description: Validation of configuration failed
226 description: Internal error
228 summary: Returns the configuration of all xapps
231 operationId: getAllXappConfig
236 description: successful query of xApp config
238 $ref: '#/definitions/AllXappConfig'
240 description: Internal error
242 summary: Delete xApp configuration
245 operationId: deleteXappConfig
247 - name: ConfigMetadata
249 description: xApp configuration information
251 $ref: '#/definitions/ConfigMetadata'
254 description: Successful deletion of xApp
256 description: Invalid parameters supplied
258 description: Internal error
261 summary: Subscribe event
265 operationId: addSubscription
271 - name: subscriptionRequest
273 description: New subscription
276 $ref: '#/definitions/subscriptionRequest'
279 description: Subscription successful
281 $ref: '#/definitions/subscriptionResponse'
283 description: Invalid input
285 summary: Returns all subscriptions
289 operationId: getSubscriptions
294 description: successful query of subscriptions
296 $ref: '#/definitions/allSubscriptions'
297 '/subscriptions/{subscriptionId}':
299 summary: Returns the information of subscription
303 operationId: getSubscriptionById
307 - name: subscriptionId
309 description: ID of subscription
314 description: successful operation
316 $ref: '#/definitions/subscription'
318 description: Invalid ID supplied
320 description: Subscription not found
322 summary: Modify event subscription
326 operationId: modifySubscription
332 - name: subscriptionId
334 description: ID of subscription
338 name: subscriptionRequest
339 description: Modified subscription
342 $ref: '#/definitions/subscriptionRequest'
345 description: Subscription modification successful
347 $ref: '#/definitions/subscriptionResponse'
349 description: Invalid input
351 summary: Unsubscribe event
356 operationId: deleteSubscription
358 - name: subscriptionId
360 description: ID of subscription
365 description: Successful deletion of subscription
367 description: Invalid subscription supplied
372 $ref: '#/definitions/Xapp'
383 description: xapp status in the RIC
397 $ref: '#/definitions/XappInstance'
405 example: xapp-dummy-6cd577d9-4v255
408 description: xapp instance status
427 example: ControlIndication
432 example: LoadIndication
442 description: Name of the xApp
446 description: Name of the config map
447 example: xapp-dummy-config-map
450 description: Name of the namespace
460 $ref: '#/definitions/ConfigMetadata'
463 description: Schema of configuration in JSON format
466 description: Configuration in JSON format
470 $ref: '#/definitions/XAppConfig'
481 example: 'http://localhost:11111/apps/webhook/'
484 description: Event which is subscribed
491 description: Maximum number of retries
495 description: Time in seconds to wait before next retry
497 subscriptionResponse:
502 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
508 description: Event which is subscribed
517 $ref: '#/definitions/subscription'
523 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
526 example: 'http://localhost:11111/apps/webhook/'
529 description: Event which is subscribed
537 description: Maximum number of retries
541 description: Time in seconds to wait before next retry
543 subscriptionNotification:
548 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
554 description: Event to be notified
560 $ref: '#/definitions/AllXapps'