3 description: This is a draft API for RIC appmgr
8 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
16 summary : Health check of xApp Manager - Liveness probe
19 operationId : getHealthAlive
22 description : Status of xApp Manager is ok
25 summary : Readiness check of xApp Manager - Readiness probe
28 operationId : getHealthReady
31 description : xApp Manager is ready for service
33 description: xApp Manager is not ready for service
36 summary: Deploy a xapp
39 operationId: deployXapp
47 description: xApp information
55 description: Name of the xApp.
59 description: Name of the xApp configmap. Overrides the value given in Helm chart value file.
60 example: xapp-dummy-configmap
63 description: Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.
67 description: Name of the service xApp is providing. Overrides the value given in Helm chart value file.
68 example: xapp-dummy-service
71 description: Name of the docker repository xApp is located. Overrides the value given in Helm chart value file.
75 description: Hostname for the pod. Used by messaging library. Overrides the value given in Helm chart value file.
79 description: xApp successfully created
81 $ref: '#/definitions/Xapp'
83 description: Invalid input
85 description: Internal error
87 summary: Returns the status of all xapps
90 operationId: getAllXapps
95 description: successful query of xApps
97 $ref: '#/definitions/AllDeployedXapps'
99 description: Internal error
102 summary: Returns the list of all deployable xapps
105 operationId: listAllXapps
110 description: successful list of deployable xApps
112 $ref: '#/definitions/AllDeployableXapps'
114 description: Internal error
117 summary: Returns the status of a given xapp
120 operationId: getXappByName
126 description: Name of xApp
131 description: successful operation
133 $ref: '#/definitions/Xapp'
135 description: Invalid ID supplied
137 description: Xapp not found
139 description: Internal error
141 summary: Undeploy an existing xapp
144 operationId: undeployXapp
148 description: Xapp to be undeployed
153 description: Successful deletion of xApp
155 description: Invalid xApp name supplied
157 description: Internal error
158 '/xapps/{xAppName}/instances/{xAppInstanceName}':
160 summary: Returns the status of a given xapp
163 operationId: getXappInstanceByName
169 description: Name of xApp
172 - name: xAppInstanceName
174 description: Name of xApp instance to get information
179 description: successful operation
181 $ref: '#/definitions/XappInstance'
183 description: Invalid name supplied
185 description: Xapp not found
187 description: Internal error
190 summary: Create xApp config
193 operationId: createXappConfig
201 description: xApp config
203 $ref: '#/definitions/XAppConfig'
206 description: xApp config successfully created
208 $ref: '#/definitions/XAppConfig'
210 description: Invalid input
212 description: Validation of configuration failed
214 description: Internal error
216 summary: Modify xApp config
219 operationId: ModifyXappConfig
227 description: xApp config
229 $ref: '#/definitions/XAppConfig'
232 description: xApp config successfully modified
234 $ref: '#/definitions/XAppConfig'
236 description: Invalid input
238 description: Validation of configuration failed
240 description: Internal error
242 summary: Returns the configuration of all xapps
245 operationId: getAllXappConfig
250 description: successful query of xApp config
252 $ref: '#/definitions/AllXappConfig'
254 description: Internal error
256 summary: Delete xApp configuration
259 operationId: deleteXappConfig
261 - name: ConfigMetadata
263 description: xApp configuration information
265 $ref: '#/definitions/ConfigMetadata'
268 description: Successful deletion of xApp config
270 description: Invalid parameters supplied
272 description: Internal error
275 summary: Subscribe event
279 operationId: addSubscription
285 - name: subscriptionRequest
287 description: New subscription
290 $ref: '#/definitions/subscriptionRequest'
293 description: Subscription successfully created
295 $ref: '#/definitions/subscriptionResponse'
297 description: Invalid input
299 summary: Returns all subscriptions
303 operationId: getSubscriptions
308 description: successful query of subscriptions
310 $ref: '#/definitions/allSubscriptions'
311 '/subscriptions/{subscriptionId}':
313 summary: Returns the information of subscription
317 operationId: getSubscriptionById
321 - name: subscriptionId
323 description: ID of subscription
328 description: successful operation
330 $ref: '#/definitions/subscription'
332 description: Invalid ID supplied
334 description: Subscription not found
336 summary: Modify event subscription
340 operationId: modifySubscription
346 - name: subscriptionId
348 description: ID of subscription
352 name: subscriptionRequest
353 description: Modified subscription
356 $ref: '#/definitions/subscriptionRequest'
359 description: Subscription modification successful
361 $ref: '#/definitions/subscriptionResponse'
363 description: Invalid input
365 summary: Unsubscribe event
370 operationId: deleteSubscription
372 - name: subscriptionId
374 description: ID of subscription
379 description: Successful deletion of subscription
381 description: Invalid subscription supplied
387 example: "xapp-dummy"
391 $ref: '#/definitions/Xapp'
402 description: xapp status in the RIC
416 $ref: '#/definitions/XappInstance'
424 example: xapp-dummy-6cd577d9-4v255
427 description: xapp instance status
446 example: ControlIndication
451 example: LoadIndication
461 description: Name of the xApp
465 description: Name of the config map
466 example: xapp-dummy-config-map
469 description: Name of the namespace
479 $ref: '#/definitions/ConfigMetadata'
482 description: Schema of configuration in JSON format
485 description: Configuration in JSON format
489 $ref: '#/definitions/XAppConfig'
500 example: 'http://localhost:11111/apps/webhook/'
503 description: Event which is subscribed
510 description: Maximum number of retries
514 description: Time in seconds to wait before next retry
516 subscriptionResponse:
521 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
527 description: Event which is subscribed
536 $ref: '#/definitions/subscription'
542 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
545 example: 'http://localhost:11111/apps/webhook/'
548 description: Event which is subscribed
556 description: Maximum number of retries
560 description: Time in seconds to wait before next retry
562 subscriptionNotification:
567 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
573 description: Event to be notified
579 $ref: '#/definitions/AllDeployedXapps'