1 #==================================================================================
2 # Copyright (c) 2019 AT&T Intellectual Property.
3 # Copyright (c) 2019 Nokia
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16 #==================================================================================
19 description: This is a draft API for RIC appmgr
24 url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
32 summary : Health check of xApp Manager - Liveness probe
35 operationId : getHealthAlive
38 description : Status of xApp Manager is ok
41 summary : Readiness check of xApp Manager - Readiness probe
44 operationId : getHealthReady
47 description : xApp Manager is ready for service
49 description: xApp Manager is not ready for service
52 summary: Deploy a xapp
55 operationId: deployXapp
61 - name: XappDescriptor
63 description: xApp deployment info
65 $ref: '#/definitions/XappDescriptor'
68 description: xApp successfully created
70 $ref: '#/definitions/Xapp'
72 description: Invalid input
74 description: Internal error
76 summary: Returns the status of all xapps
79 operationId: getAllXapps
84 description: successful query of xApps
86 $ref: '#/definitions/AllDeployedXapps'
88 description: Internal error
91 summary: Returns the list of all deployable xapps
94 operationId: listAllXapps
99 description: successful list of deployable xApps
101 $ref: '#/definitions/AllDeployableXapps'
103 description: Internal error
106 summary: Returns the status of a given xapp
109 operationId: getXappByName
115 description: Name of xApp
120 description: successful operation
122 $ref: '#/definitions/Xapp'
124 description: Invalid ID supplied
126 description: Xapp not found
128 description: Internal error
130 summary: Undeploy an existing xapp
133 operationId: undeployXapp
137 description: Xapp to be undeployed
142 description: Successful deletion of xApp
144 description: Invalid xApp name supplied
146 description: Internal error
147 /xapps/{xAppName}/instances/{xAppInstanceName}:
149 summary: Returns the status of a given xapp
152 operationId: getXappInstanceByName
158 description: Name of xApp
161 - name: xAppInstanceName
163 description: Name of xApp instance to get information
168 description: successful operation
170 $ref: '#/definitions/XappInstance'
172 description: Invalid name supplied
174 description: Xapp not found
176 description: Internal error
179 summary: Modify xApp config
182 operationId: ModifyXappConfig
190 description: xApp config
192 $ref: '#/definitions/XAppConfig'
195 description: xApp config successfully modified
197 $ref: '#/definitions/ConfigValidationErrors'
199 description: Invalid input
201 description: Validation of configuration failed
203 description: Internal error
205 summary: Returns the configuration of all xapps
208 operationId: getAllXappConfig
213 description: successful query of xApp config
215 $ref: '#/definitions/AllXappConfig'
217 description: Internal error
220 summary: Returns the given element of the configuration
223 operationId: GetConfigElement
229 description: Name of configuration element
234 description: successful query of config elements
236 $ref: '#/definitions/AllXappConfig'
238 description: Internal error
241 summary: Subscribe event
245 operationId: addSubscription
251 - name: subscriptionRequest
253 description: New subscription
256 $ref: '#/definitions/subscriptionRequest'
259 description: Subscription successfully created
261 $ref: '#/definitions/subscriptionResponse'
263 description: Invalid input
265 summary: Returns all subscriptions
269 operationId: getSubscriptions
274 description: successful query of subscriptions
276 $ref: '#/definitions/allSubscriptions'
277 /subscriptions/{subscriptionId}:
279 summary: Returns the information of subscription
283 operationId: getSubscriptionById
287 - name: subscriptionId
289 description: ID of subscription
294 description: successful operation
296 $ref: '#/definitions/subscription'
298 description: Invalid ID supplied
300 description: Subscription not found
302 summary: Modify event subscription
306 operationId: modifySubscription
312 - name: subscriptionId
314 description: ID of subscription
318 name: subscriptionRequest
319 description: Modified subscription
322 $ref: '#/definitions/subscriptionRequest'
325 description: Subscription modification successful
327 $ref: '#/definitions/subscriptionResponse'
329 description: Invalid input
331 summary: Unsubscribe event
336 operationId: deleteSubscription
338 - name: subscriptionId
340 description: ID of subscription
345 description: Successful deletion of subscription
347 description: Invalid subscription supplied
350 summary: Register a new xApp
354 operationId: registerXapp
360 - name: registerRequest
362 description: New xApp registration
365 $ref: '#/definitions/registerRequest'
368 description: Registration successful
370 description: Invalid input
373 summary: Deregister an existing xApp
377 operationId: deregisterXapp
381 - name: deregisterRequest
383 description: Xapp to be unregistered
386 $ref: '#/definitions/deregisterRequest'
389 description: Successful deregistration of xApp
391 description: Invalid xApp name supplied
393 description: Internal error
402 $ref: '#/definitions/Xapp'
412 description: xapp status in the RIC
425 $ref: '#/definitions/XappInstance'
435 description: xapp instance status
467 description: Name of the xApp in helm chart
470 description: The exact xapp helm chart version to install
473 description: Name of the xapp to be visible in Kubernetes
476 description: Name of the namespace to which xApp is deployed. Overrides the value given in Helm chart value file.
479 description: JSON string of override file for 'helm install' command
483 $ref: '#/definitions/XappDescriptor'
492 description: Name of the xApp
495 description: Name of the namespace
496 ConfigValidationError:
504 description: Name of the parameter
507 description: Description of validation error
508 ConfigValidationErrors:
511 $ref: '#/definitions/ConfigValidationError'
519 $ref: '#/definitions/ConfigMetadata'
522 description: Configuration in JSON format
526 $ref: '#/definitions/XAppConfig'
529 description: Event which is subscribed
548 example: 'http://localhost:11111/apps/webhook/'
550 $ref: '#/definitions/EventType'
553 description: Maximum number of retries
556 description: Time in seconds to wait before next retry
563 $ref: '#/definitions/SubscriptionData'
564 subscriptionResponse:
572 $ref: '#/definitions/EventType'
576 $ref: '#/definitions/subscription'
583 $ref: '#/definitions/SubscriptionData'
584 subscriptionNotification:
592 $ref: '#/definitions/EventType'
594 $ref: '#/definitions/AllDeployedXapps'
617 description: Configuration in JSON string format