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
20 operationId: getHealth
23 description: Status of xApp Manager is ok
26 summary: Deploy a xapp
29 operationId: deployXapp
37 description: xApp information
45 description: Name of the xApp
49 description: xApp successfully created
51 $ref: '#/definitions/Xapp'
53 description: Invalid input
55 description: Internal error
57 summary: Returns the status of all xapps
60 operationId: getAllXapps
65 description: successful query of xApps
67 $ref: '#/definitions/AllXapps'
69 description: Internal error
72 summary: Returns the status of a given xapp
75 operationId: getXappByName
81 description: Name of xApp
86 description: successful operation
88 $ref: '#/definitions/Xapp'
90 description: Invalid ID supplied
92 description: Xapp not found
94 description: Internal error
96 summary: Undeploy an existing xapp
99 operationId: undeployXapp
103 description: Xapp to be undeployed
108 description: Successful deletion of xApp
110 description: Invalid xApp name supplied
112 description: Internal error
113 '/xapps/{xAppName}/instances/{xAppInstanceName}':
115 summary: Returns the status of a given xapp
118 operationId: getXappInstanceByName
124 description: Name of xApp
127 - name: xAppInstanceName
129 description: Name of xApp instance to get information
134 description: successful operation
136 $ref: '#/definitions/XappInstance'
138 description: Invalid name supplied
140 description: Xapp not found
142 description: Internal error
145 summary: Create xApp config
148 operationId: createXappConfig
156 description: xApp config
158 $ref: '#/definitions/xAppConfig'
161 description: xApp config successfully created
163 $ref: '#/definitions/xAppConfig'
165 description: Invalid input
167 description: Validation of configuration failed
169 description: Internal error
171 summary: Modify xApp config
174 operationId: ModifyXappConfig
182 description: xApp config
184 $ref: '#/definitions/xAppConfig'
187 description: xApp config successfully modified
189 $ref: '#/definitions/xAppConfig'
191 description: Invalid input
193 description: Validation of configuration failed
195 description: Internal error
197 summary: Returns the configuration of all xapps
200 operationId: getAllXappConfig
205 description: successful query of xApp config
207 $ref: '#/definitions/AllXappConfig'
209 description: Internal error
211 summary: Delete xApp configuration
214 operationId: deleteXappConfig
216 - name: xAppConfigInfo
218 description: xApp configuration information
220 $ref: '#/definitions/xAppConfigInfo'
223 description: Successful deletion of xApp
225 description: Invalid parameters supplied
227 description: Internal error
230 summary: Subscribe event
234 operationId: addSubscription
240 - name: subscriptionRequest
242 description: New subscription
245 $ref: '#/definitions/subscriptionRequest'
248 description: Subscription successful
250 $ref: '#/definitions/subscriptionResponse'
252 description: Invalid input
254 summary: Returns all subscriptions
258 operationId: getSubscriptions
263 description: successful query of subscriptions
265 $ref: '#/definitions/allSubscriptions'
266 '/subscriptions/{subscriptionId}':
268 summary: Returns the information of subscription
272 operationId: getSubscriptionById
276 - name: subscriptionId
278 description: ID of subscription
283 description: successful operation
285 $ref: '#/definitions/subscription'
287 description: Invalid ID supplied
289 description: Subscription not found
291 summary: Modify event subscription
295 operationId: modifySubscription
301 - name: subscriptionId
303 description: ID of subscription
307 name: subscriptionRequest
308 description: Modified subscription
311 $ref: '#/definitions/subscriptionRequest'
314 description: Subscription modification successful
316 $ref: '#/definitions/subscriptionResponse'
318 description: Invalid input
320 summary: Unsubscribe event
325 operationId: deleteSubscription
327 - name: subscriptionId
329 description: ID of subscription
334 description: Successful deletion of subscription
336 description: Invalid subscription supplied
341 $ref: '#/definitions/Xapp'
352 description: xapp status in the RIC
366 $ref: '#/definitions/XappInstance'
374 example: xapp-dummy-6cd577d9-4v255
377 description: xapp instance status
396 example: ControlIndication
401 example: LoadIndication
411 description: Name of the xApp
415 description: Name of the config map
416 example: xapp-dummy-config-map
419 description: Name of the namespace
429 $ref: '#/definitions/xAppConfigInfo'
432 description: Schema of configuration in JSON format
435 description: Configuration in JSON format
439 $ref: '#/definitions/xAppConfig'
450 example: 'http://localhost:11111/apps/webhook/'
453 description: Event which is subscribed
460 description: Maximum number of retries
464 description: Time in seconds to wait before next retry
466 subscriptionResponse:
471 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
477 description: Event which is subscribed
486 $ref: '#/definitions/subscription'
492 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
495 example: 'http://localhost:11111/apps/webhook/'
498 description: Event which is subscribed
506 description: Maximum number of retries
510 description: Time in seconds to wait before next retry
512 subscriptionNotification:
517 example: 1ILBltYYzEGzWRrVPZKmuUmhwcc
523 description: Event to be notified
529 $ref: '#/definitions/AllXapps'