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
45 - name: XappDescriptor
47 description: xApp deployment info
49 $ref: '#/definitions/XappDescriptor'
52 description: xApp successfully created
54 $ref: '#/definitions/Xapp'
56 description: Invalid input
58 description: Internal error
60 summary: Returns the status of all xapps
63 operationId: getAllXapps
68 description: successful query of xApps
70 $ref: '#/definitions/AllDeployedXapps'
72 description: Internal error
75 summary: Returns the list of all deployable xapps
78 operationId: listAllXapps
83 description: successful list of deployable xApps
85 $ref: '#/definitions/AllDeployableXapps'
87 description: Internal error
90 summary: Returns the status of a given xapp
93 operationId: getXappByName
99 description: Name of xApp
104 description: successful operation
106 $ref: '#/definitions/Xapp'
108 description: Invalid ID supplied
110 description: Xapp not found
112 description: Internal error
114 summary: Undeploy an existing xapp
117 operationId: undeployXapp
121 description: Xapp to be undeployed
126 description: Successful deletion of xApp
128 description: Invalid xApp name supplied
130 description: Internal error
131 /xapps/{xAppName}/instances/{xAppInstanceName}:
133 summary: Returns the status of a given xapp
136 operationId: getXappInstanceByName
142 description: Name of xApp
145 - name: xAppInstanceName
147 description: Name of xApp instance to get information
152 description: successful operation
154 $ref: '#/definitions/XappInstance'
156 description: Invalid name supplied
158 description: Xapp not found
160 description: Internal error
161 /xapps/{xAppName}/instances/{xAppInstanceName}/start:
163 summary: Start given xapp instance
166 operationId: startXappInstanceByName
172 description: Name of xApp
175 - name: xAppInstanceName
177 description: Name of xApp instance to get information
182 description: successful operation
184 description: Invalid name supplied
186 description: Xapp not found
188 description: Internal error
189 /xapps/{xAppName}/instances/{xAppInstanceName}/stop:
191 summary: Stop given xapp instance
194 operationId: stopXappInstanceByName
200 description: Name of xApp
203 - name: xAppInstanceName
205 description: Name of xApp instance to get information
210 description: successful operation
212 description: Invalid name supplied
214 description: Xapp not found
216 description: Internal error
219 summary: Create xApp config
222 operationId: createXappConfig
230 description: xApp config
232 $ref: '#/definitions/XAppConfig'
235 description: xApp config successfully created
237 $ref: '#/definitions/ConfigValidationErrors'
239 description: Invalid input
241 description: Validation of configuration failed
243 description: Internal error
245 summary: Modify xApp config
248 operationId: ModifyXappConfig
256 description: xApp config
258 $ref: '#/definitions/XAppConfig'
261 description: xApp config successfully modified
263 $ref: '#/definitions/ConfigValidationErrors'
265 description: Invalid input
267 description: Validation of configuration failed
269 description: Internal error
271 summary: Returns the configuration of all xapps
274 operationId: getAllXappConfig
279 description: successful query of xApp config
281 $ref: '#/definitions/AllXappConfig'
283 description: Internal error
285 summary: Delete xApp configuration
288 operationId: deleteXappConfig
290 - name: ConfigMetadata
292 description: xApp configuration information
294 $ref: '#/definitions/ConfigMetadata'
297 description: Successful deletion of xApp config
299 description: Invalid parameters supplied
301 description: Internal error
302 /config/{configName}:
304 summary: Returns the configuration of a single xapp
307 operationId: getXappConfig
313 description: Name of xApp
318 description: successful query of xApp config
320 $ref: '#/definitions/XAppConfig'
322 description: Internal error
325 summary: Subscribe event
329 operationId: addSubscription
335 - name: subscriptionRequest
337 description: New subscription
340 $ref: '#/definitions/subscriptionRequest'
343 description: Subscription successfully created
345 $ref: '#/definitions/subscriptionResponse'
347 description: Invalid input
349 summary: Returns all subscriptions
353 operationId: getSubscriptions
358 description: successful query of subscriptions
360 $ref: '#/definitions/allSubscriptions'
361 /subscriptions/{subscriptionId}:
363 summary: Returns the information of subscription
367 operationId: getSubscriptionById
371 - name: subscriptionId
373 description: ID of subscription
378 description: successful operation
380 $ref: '#/definitions/subscription'
382 description: Invalid ID supplied
384 description: Subscription not found
386 summary: Modify event subscription
390 operationId: modifySubscription
396 - name: subscriptionId
398 description: ID of subscription
402 name: subscriptionRequest
403 description: Modified subscription
406 $ref: '#/definitions/subscriptionRequest'
409 description: Subscription modification successful
411 $ref: '#/definitions/subscriptionResponse'
413 description: Invalid input
415 summary: Unsubscribe event
420 operationId: deleteSubscription
422 - name: subscriptionId
424 description: ID of subscription
429 description: Successful deletion of subscription
431 description: Invalid subscription supplied
440 $ref: '#/definitions/Xapp'
450 description: xapp status in the RIC
463 $ref: '#/definitions/XappInstance'
473 description: xapp instance status
505 description: Name of the xApp in helm chart
508 description: The exact xapp helm chart version to install
511 description: Name of the xapp to be visible in Kubernetes
514 description: Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.
517 description: JSON string of override file for 'helm install' command
521 $ref: '#/definitions/XappDescriptor'
529 description: Name of the xApp
532 description: Name of the config map
535 description: Name of the namespace
536 ConfigValidationError:
544 description: Name of the parameter
547 description: Description of validation error
548 ConfigValidationErrors:
551 $ref: '#/definitions/ConfigValidationError'
560 $ref: '#/definitions/ConfigMetadata'
563 description: Schema of configuration in JSON format
566 description: Configuration in JSON format
570 $ref: '#/definitions/XAppConfig'
573 description: Event which is subscribed
592 example: 'http://localhost:11111/apps/webhook/'
594 $ref: '#/definitions/EventType'
597 description: Maximum number of retries
600 description: Time in seconds to wait before next retry
607 $ref: '#/definitions/SubscriptionData'
608 subscriptionResponse:
616 $ref: '#/definitions/EventType'
620 $ref: '#/definitions/subscription'
627 $ref: '#/definitions/SubscriptionData'
628 subscriptionNotification:
636 $ref: '#/definitions/EventType'
638 $ref: '#/definitions/AllDeployedXapps'