#
#
# Abstract: Routing Manager's RESTful API definition
-# Date: 29 March 2019
+# Date: 28 August 2019
#
swagger: "2.0"
info:
title: Routing Manager
description: "This is the Swagger/OpenAPI 2.0 definition of Routing Manager's Northbound API."
- version: "0.3.0"
+ version: "0.4.0"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
description: "Invalid data"
201:
description: "Xapp Subscription data received"
+ delete:
+ tags:
+ - "handle"
+ summary: "API for deleting an xapp subscription"
+ description: "By performing the delete operation on xapp-subscription-handle resource, the API caller will be able to update routing manager about the deletion of an xapp's subscription"
+ operationId: "delete_xapp_subscription_handle"
+ consumes:
+ - "application/json"
+ parameters:
+ - in: "body"
+ name: "xapp-subscription-data"
+ description: "xApp related subscription data"
+ required: true
+ schema:
+ $ref: "#/definitions/xapp-subscription-data"
+ responses:
+ 204:
+ description: "Content not found"
+ 200:
+ description: "Xapp Subscription deleted"
+ /handles/xapp-subscription-handle/{subscription_id}:
+ put:
+ tags:
+ - "handle"
+ summary: "API for updating the subscriber xApp list"
+ description: "By performing a PUT method on a xapp-subscription-handle/{subscription_id} resource, the API caller is able to update the Routing manager about the list of subscriber xApps related to the subscription denoted by the {subsription_id}."
+ operationId: "update_xapp_subscription_handle"
+ consumes:
+ - "application/json"
+# - "application/yaml"
+ produces:
+ - "application/json"
+# - "application/yaml"
+ parameters:
+ - in: path
+ name: subscription_id
+ required: true
+ type: integer
+ format: "uint16"
+ description: "Subscription ID"
+ - in: body
+ name: xapp-list
+ description: "xApp list"
+ required: true
schema:
- $ref: "#/definitions/xapp-subscription-data-response"
+ $ref: "#/definitions/xapp-list"
+ responses:
+ 400:
+ description: "Invalid data"
+ 201:
+ description: "Xapp list received"
+
definitions:
health-status:
type: "object"
type: "object"
properties:
id:
- type: "integer"
- format: "int64"
+ type: "string"
event:
type: "string"
version:
maximum: 65535
subscription_id: #subscription sequence number
type: "integer"
- format: "int32"
- xapp-subscription-data-response:
+ format: "int32"
+ xapp-list:
+ type: "array"
+ items:
+ $ref: '#/definitions/xapp-element'
+ xapp-element:
type: "object"
required:
- - "location"
+ - "address"
+ - "port"
properties:
- location:
- type: "string"
+ address:
+ type: "string" #This is the xapp instance hostname or ip address
+ port: #xapp instance port address
+ type: "integer"
+ format: "uint16"
+ minimum: 0
+ maximum: 65535
externalDocs:
description: "Routing Manager"
url: "http://placeholder"
+