2 #==================================================================================
3 # Copyright (c) 2019 AT&T Intellectual Property.
4 # Copyright (c) 2019 Nokia
6 # Licensed under the Apache License, Version 2.0 (the "License");
7 # you may not use this file except in compliance with the License.
8 # You may obtain a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS,
14 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 #==================================================================================
20 # Abstract: Routing Manager's RESTful API definition
21 # Date: 28 August 2019
25 title: Routing Manager
26 description: "This is the Swagger/OpenAPI 2.0 definition of Routing Manager's Northbound API."
30 url: "http://www.apache.org/licenses/LICENSE-2.0.html"
35 description: "Available handles"
37 # description: "Find out more"
38 # url: "http://127.0.0.1"
40 description: "Health of the system"
49 summary: "Retrive the health of Routing Manager"
50 description: "By performing a GET method on the health resource, the API caller is able to retrieve the health of Routing Manager"
51 operationId: "get_health"
54 # - "application/yaml"
57 # - "application/yaml"
60 description: "The health of the system"
62 "$ref": "#/definitions/health-status"
67 summary: "Placeholder for further usage"
68 description: "Placeholder for further usage."
69 operationId: "get_handles"
72 # - "application/yaml"
75 # - "application/yaml"
78 description: "Dummy response"
83 summary: "Provide callback"
84 description: "By performing a POST method on the xapp-handle resource, the API caller is able to perform a callback on Routing Manager."
85 operationId: "provide_xapp_handle"
88 # - "application/yaml"
91 # - "application/yaml"
94 name: "xapp-callback-data"
95 description: "xApp related callback data"
98 $ref: "#/definitions/xapp-callback-data"
101 description: "Invalid data"
103 description: "Callback received"
104 /handles/xapp-subscription-handle:
108 summary: "API for updating about new xapp subscription"
109 description: "By performing a POST method on the xapp-subscription-handle resource, the API caller is able to update the Routing manager about the creation of new subscription by an Xapp instance."
110 operationId: "provide_xapp_subscription_handle"
113 # - "application/yaml"
116 # - "application/yaml"
119 name: "xapp-subscription-data"
120 description: "xApp related subscription data"
123 $ref: "#/definitions/xapp-subscription-data"
126 description: "Invalid data"
128 description: "Xapp Subscription data received"
132 summary: "API for deleting an xapp subscription"
133 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"
134 operationId: "delete_xapp_subscription_handle"
139 name: "xapp-subscription-data"
140 description: "xApp related subscription data"
143 $ref: "#/definitions/xapp-subscription-data"
146 description: "Content not found"
148 description: "Xapp Subscription deleted"
149 /handles/xapp-subscription-handle/{subscription_id}:
153 summary: "API for updating the subscriber xApp list"
154 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}."
155 operationId: "update_xapp_subscription_handle"
158 # - "application/yaml"
161 # - "application/yaml"
164 name: subscription_id
168 description: "Subscription ID"
171 description: "xApp list"
174 $ref: "#/definitions/xapp-list"
177 description: "Invalid data"
179 description: "Xapp list received"
201 type: "string" #This should be a JSON object, array of xapps
202 xapp-subscription-data:
210 type: "string" #This is the xapp instance hostname or ip address
211 port: #xapp instance port address
216 subscription_id: #subscription sequence number
222 $ref: '#/definitions/xapp-element'
230 type: "string" #This is the xapp instance hostname or ip address
231 port: #xapp instance port address
238 description: "Routing Manager"
239 url: "http://placeholder"