pkg/restapi/embedded_spec.go

   1 // Code generated by go-swagger; DO NOT EDIT.
   2
   3 package restapi
   4
   5 // This file was generated by the swagger tool.
   6 // Editing this file might prove futile when you re-run the swagger generate command
   7
   8 import (
   9         "encoding/json"
  10 )
  11
  12 var (
  13         // SwaggerJSON embedded version of the swagger document used at generation time
  14         SwaggerJSON json.RawMessage
  15         // FlatSwaggerJSON embedded flattened version of the swagger document used at generation time
  16         FlatSwaggerJSON json.RawMessage
  17 )
  18
  19 func init() {
  20         SwaggerJSON = json.RawMessage([]byte(`{
  21   "schemes": [
  22     "http"
  23   ],
  24   "swagger": "2.0",
  25   "info": {
  26     "description": "This is the initial REST API for RIC subscription",
  27     "title": "RIC subscription",
  28     "license": {
  29       "name": "Apache 2.0",
  30       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
  31     },
  32     "version": "0.0.1"
  33   },
  34   "host": "hostname",
  35   "basePath": "/ric/v1",
  36   "paths": {
  37     "/subscriptions/control": {
  38       "post": {
  39         "consumes": [
  40           "application/json"
  41         ],
  42         "produces": [
  43           "application/json"
  44         ],
  45         "tags": [
  46           "control"
  47         ],
  48         "summary": "Subscribe and send \"CONTROL\" message to RAN to initiate or resume call processing in RAN",
  49         "operationId": "subscribeControl",
  50         "parameters": [
  51           {
  52             "description": "Subscription control parameters",
  53             "name": "ControlParams",
  54             "in": "body",
  55             "schema": {
  56               "$ref": "#/definitions/ControlParams"
  57             }
  58           }
  59         ],
  60         "responses": {
  61           "201": {
  62             "description": "Subscription successfully created",
  63             "schema": {
  64               "$ref": "#/definitions/SubscriptionResult"
  65             }
  66           },
  67           "400": {
  68             "description": "Invalid input"
  69           },
  70           "500": {
  71             "description": "Internal error"
  72           }
  73         }
  74       }
  75     },
  76     "/subscriptions/policy": {
  77       "post": {
  78         "consumes": [
  79           "application/json"
  80         ],
  81         "produces": [
  82           "application/json"
  83         ],
  84         "tags": [
  85           "policy"
  86         ],
  87         "summary": "Subscribe and send \"POLICY\" message to RAN to execute a specific POLICY during call processing in RAN after each occurrence of a defined SUBSCRIPTION",
  88         "operationId": "subscribePolicy",
  89         "parameters": [
  90           {
  91             "description": "Subscription policy parameters",
  92             "name": "PolicyParams",
  93             "in": "body",
  94             "schema": {
  95               "$ref": "#/definitions/PolicyParams"
  96             }
  97           }
  98         ],
  99         "responses": {
 100           "201": {
 101             "description": "Subscription successfully created",
 102             "schema": {
 103               "$ref": "#/definitions/SubscriptionResult"
 104             }
 105           },
 106           "400": {
 107             "description": "Invalid input"
 108           },
 109           "500": {
 110             "description": "Internal error"
 111           }
 112         }
 113       }
 114     },
 115     "/subscriptions/report": {
 116       "post": {
 117         "consumes": [
 118           "application/json"
 119         ],
 120         "produces": [
 121           "application/json"
 122         ],
 123         "tags": [
 124           "report"
 125         ],
 126         "summary": "Subscribe a list of X2AP event triggers to receive \"REPORT\" messages sent by RAN",
 127         "operationId": "subscribeReport",
 128         "parameters": [
 129           {
 130             "description": "Subscription report parameters",
 131             "name": "ReportParams",
 132             "in": "body",
 133             "schema": {
 134               "$ref": "#/definitions/ReportParams"
 135             }
 136           }
 137         ],
 138         "responses": {
 139           "201": {
 140             "description": "Subscription successfully created",
 141             "schema": {
 142               "$ref": "#/definitions/SubscriptionResult"
 143             }
 144           },
 145           "400": {
 146             "description": "Invalid input"
 147           },
 148           "500": {
 149             "description": "Internal error"
 150           }
 151         }
 152       }
 153     },
 154     "/subscriptions/{subscriptionId}": {
 155       "delete": {
 156         "tags": [
 157           "common"
 158         ],
 159         "summary": "Unsubscribe X2AP events from Subscription Manager",
 160         "operationId": "Unsubscribe",
 161         "parameters": [
 162           {
 163             "type": "integer",
 164             "description": "The subscriptionId to be unsubscribed",
 165             "name": "subscriptionId",
 166             "in": "path",
 167             "required": true
 168           }
 169         ],
 170         "responses": {
 171           "204": {
 172             "description": "Operation done successfully"
 173           },
 174           "400": {
 175             "description": "Invalid requestorId supplied"
 176           },
 177           "500": {
 178             "description": "Internal error"
 179           }
 180         }
 181       }
 182     }
 183   },
 184   "definitions": {
 185     "ControlParams": {
 186       "type": "object",
 187       "properties": {
 188         "RequestorId": {
 189           "type": "integer"
 190         },
 191         "TBD": {
 192           "type": "string"
 193         }
 194       }
 195     },
 196     "EventTrigger": {
 197       "type": "object",
 198       "required": [
 199         "InterfaceDirection",
 200         "ProcedureCode",
 201         "TypeOfMessage"
 202       ],
 203       "properties": {
 204         "ENBId": {
 205           "type": "integer"
 206         },
 207         "InterfaceDirection": {
 208           "type": "integer"
 209         },
 210         "PlmnId": {
 211           "type": "string"
 212         },
 213         "ProcedureCode": {
 214           "type": "integer"
 215         },
 216         "TypeOfMessage": {
 217           "type": "integer"
 218         }
 219       }
 220     },
 221     "EventTriggerList": {
 222       "type": "array",
 223       "items": {
 224         "$ref": "#/definitions/EventTrigger"
 225       }
 226     },
 227     "PolicyParams": {
 228       "type": "object",
 229       "properties": {
 230         "RequestorId": {
 231           "type": "integer"
 232         },
 233         "TBD": {
 234           "type": "string"
 235         }
 236       }
 237     },
 238     "ReportParams": {
 239       "type": "object",
 240       "required": [
 241         "RequestorId",
 242         "EventTriggers"
 243       ],
 244       "properties": {
 245         "EventTriggers": {
 246           "$ref": "#/definitions/EventTriggerList"
 247         },
 248         "RequestorId": {
 249           "type": "integer"
 250         }
 251       }
 252     },
 253     "SubscriptionResult": {
 254       "description": "A list of unique IDs",
 255       "type": "array",
 256       "items": {
 257         "type": "integer"
 258       }
 259     },
 260     "SubscriptionType": {
 261       "type": "string",
 262       "enum": [
 263         "control",
 264         "insert",
 265         "policy",
 266         "report"
 267       ]
 268     }
 269   }
 270 }`))
 271         FlatSwaggerJSON = json.RawMessage([]byte(`{
 272   "schemes": [
 273     "http"
 274   ],
 275   "swagger": "2.0",
 276   "info": {
 277     "description": "This is the initial REST API for RIC subscription",
 278     "title": "RIC subscription",
 279     "license": {
 280       "name": "Apache 2.0",
 281       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
 282     },
 283     "version": "0.0.1"
 284   },
 285   "host": "hostname",
 286   "basePath": "/ric/v1",
 287   "paths": {
 288     "/subscriptions/control": {
 289       "post": {
 290         "consumes": [
 291           "application/json"
 292         ],
 293         "produces": [
 294           "application/json"
 295         ],
 296         "tags": [
 297           "control"
 298         ],
 299         "summary": "Subscribe and send \"CONTROL\" message to RAN to initiate or resume call processing in RAN",
 300         "operationId": "subscribeControl",
 301         "parameters": [
 302           {
 303             "description": "Subscription control parameters",
 304             "name": "ControlParams",
 305             "in": "body",
 306             "schema": {
 307               "$ref": "#/definitions/ControlParams"
 308             }
 309           }
 310         ],
 311         "responses": {
 312           "201": {
 313             "description": "Subscription successfully created",
 314             "schema": {
 315               "$ref": "#/definitions/SubscriptionResult"
 316             }
 317           },
 318           "400": {
 319             "description": "Invalid input"
 320           },
 321           "500": {
 322             "description": "Internal error"
 323           }
 324         }
 325       }
 326     },
 327     "/subscriptions/policy": {
 328       "post": {
 329         "consumes": [
 330           "application/json"
 331         ],
 332         "produces": [
 333           "application/json"
 334         ],
 335         "tags": [
 336           "policy"
 337         ],
 338         "summary": "Subscribe and send \"POLICY\" message to RAN to execute a specific POLICY during call processing in RAN after each occurrence of a defined SUBSCRIPTION",
 339         "operationId": "subscribePolicy",
 340         "parameters": [
 341           {
 342             "description": "Subscription policy parameters",
 343             "name": "PolicyParams",
 344             "in": "body",
 345             "schema": {
 346               "$ref": "#/definitions/PolicyParams"
 347             }
 348           }
 349         ],
 350         "responses": {
 351           "201": {
 352             "description": "Subscription successfully created",
 353             "schema": {
 354               "$ref": "#/definitions/SubscriptionResult"
 355             }
 356           },
 357           "400": {
 358             "description": "Invalid input"
 359           },
 360           "500": {
 361             "description": "Internal error"
 362           }
 363         }
 364       }
 365     },
 366     "/subscriptions/report": {
 367       "post": {
 368         "consumes": [
 369           "application/json"
 370         ],
 371         "produces": [
 372           "application/json"
 373         ],
 374         "tags": [
 375           "report"
 376         ],
 377         "summary": "Subscribe a list of X2AP event triggers to receive \"REPORT\" messages sent by RAN",
 378         "operationId": "subscribeReport",
 379         "parameters": [
 380           {
 381             "description": "Subscription report parameters",
 382             "name": "ReportParams",
 383             "in": "body",
 384             "schema": {
 385               "$ref": "#/definitions/ReportParams"
 386             }
 387           }
 388         ],
 389         "responses": {
 390           "201": {
 391             "description": "Subscription successfully created",
 392             "schema": {
 393               "$ref": "#/definitions/SubscriptionResult"
 394             }
 395           },
 396           "400": {
 397             "description": "Invalid input"
 398           },
 399           "500": {
 400             "description": "Internal error"
 401           }
 402         }
 403       }
 404     },
 405     "/subscriptions/{subscriptionId}": {
 406       "delete": {
 407         "tags": [
 408           "common"
 409         ],
 410         "summary": "Unsubscribe X2AP events from Subscription Manager",
 411         "operationId": "Unsubscribe",
 412         "parameters": [
 413           {
 414             "type": "integer",
 415             "description": "The subscriptionId to be unsubscribed",
 416             "name": "subscriptionId",
 417             "in": "path",
 418             "required": true
 419           }
 420         ],
 421         "responses": {
 422           "204": {
 423             "description": "Operation done successfully"
 424           },
 425           "400": {
 426             "description": "Invalid requestorId supplied"
 427           },
 428           "500": {
 429             "description": "Internal error"
 430           }
 431         }
 432       }
 433     }
 434   },
 435   "definitions": {
 436     "ControlParams": {
 437       "type": "object",
 438       "properties": {
 439         "RequestorId": {
 440           "type": "integer"
 441         },
 442         "TBD": {
 443           "type": "string"
 444         }
 445       }
 446     },
 447     "EventTrigger": {
 448       "type": "object",
 449       "required": [
 450         "InterfaceDirection",
 451         "ProcedureCode",
 452         "TypeOfMessage"
 453       ],
 454       "properties": {
 455         "ENBId": {
 456           "type": "integer"
 457         },
 458         "InterfaceDirection": {
 459           "type": "integer"
 460         },
 461         "PlmnId": {
 462           "type": "string"
 463         },
 464         "ProcedureCode": {
 465           "type": "integer"
 466         },
 467         "TypeOfMessage": {
 468           "type": "integer"
 469         }
 470       }
 471     },
 472     "EventTriggerList": {
 473       "type": "array",
 474       "items": {
 475         "$ref": "#/definitions/EventTrigger"
 476       }
 477     },
 478     "PolicyParams": {
 479       "type": "object",
 480       "properties": {
 481         "RequestorId": {
 482           "type": "integer"
 483         },
 484         "TBD": {
 485           "type": "string"
 486         }
 487       }
 488     },
 489     "ReportParams": {
 490       "type": "object",
 491       "required": [
 492         "RequestorId",
 493         "EventTriggers"
 494       ],
 495       "properties": {
 496         "EventTriggers": {
 497           "$ref": "#/definitions/EventTriggerList"
 498         },
 499         "RequestorId": {
 500           "type": "integer"
 501         }
 502       }
 503     },
 504     "SubscriptionResult": {
 505       "description": "A list of unique IDs",
 506       "type": "array",
 507       "items": {
 508         "type": "integer"
 509       }
 510     },
 511     "SubscriptionType": {
 512       "type": "string",
 513       "enum": [
 514         "control",
 515         "insert",
 516         "policy",
 517         "report"
 518       ]
 519     }
 520   }
 521 }`))
 522 }