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": {
  38       "get": {
  39         "produces": [
  40           "application/json"
  41         ],
  42         "tags": [
  43           "query"
  44         ],
  45         "summary": "Returns list of subscriptions",
  46         "operationId": "getAllSubscriptions",
  47         "responses": {
  48           "200": {
  49             "description": "successful query of subscriptions",
  50             "schema": {
  51               "$ref": "#/definitions/SubscriptionList"
  52             }
  53           },
  54           "500": {
  55             "description": "Internal error"
  56           }
  57         }
  58       }
  59     },
  60     "/subscriptions/control": {
  61       "post": {
  62         "consumes": [
  63           "application/json"
  64         ],
  65         "produces": [
  66           "application/json"
  67         ],
  68         "tags": [
  69           "control"
  70         ],
  71         "summary": "Subscribe and send \"CONTROL\" message to RAN to initiate or resume call processing in RAN",
  72         "operationId": "subscribeControl",
  73         "parameters": [
  74           {
  75             "description": "Subscription control parameters",
  76             "name": "ControlParams",
  77             "in": "body",
  78             "schema": {
  79               "$ref": "#/definitions/ControlParams"
  80             }
  81           }
  82         ],
  83         "responses": {
  84           "201": {
  85             "description": "Subscription successfully created",
  86             "schema": {
  87               "$ref": "#/definitions/SubscriptionResult"
  88             }
  89           },
  90           "400": {
  91             "description": "Invalid input"
  92           },
  93           "500": {
  94             "description": "Internal error"
  95           }
  96         }
  97       }
  98     },
  99     "/subscriptions/policy": {
 100       "post": {
 101         "consumes": [
 102           "application/json"
 103         ],
 104         "produces": [
 105           "application/json"
 106         ],
 107         "tags": [
 108           "policy"
 109         ],
 110         "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",
 111         "operationId": "subscribePolicy",
 112         "parameters": [
 113           {
 114             "description": "Subscription policy parameters",
 115             "name": "PolicyParams",
 116             "in": "body",
 117             "schema": {
 118               "$ref": "#/definitions/PolicyParams"
 119             }
 120           }
 121         ],
 122         "responses": {
 123           "201": {
 124             "description": "Subscription successfully created",
 125             "schema": {
 126               "$ref": "#/definitions/SubscriptionResult"
 127             }
 128           },
 129           "400": {
 130             "description": "Invalid input"
 131           },
 132           "500": {
 133             "description": "Internal error"
 134           }
 135         }
 136       }
 137     },
 138     "/subscriptions/report": {
 139       "post": {
 140         "consumes": [
 141           "application/json"
 142         ],
 143         "produces": [
 144           "application/json"
 145         ],
 146         "tags": [
 147           "report"
 148         ],
 149         "summary": "Subscribe a list of X2AP event triggers to receive \"REPORT\" messages sent by RAN",
 150         "operationId": "subscribeReport",
 151         "parameters": [
 152           {
 153             "description": "Subscription report parameters",
 154             "name": "ReportParams",
 155             "in": "body",
 156             "schema": {
 157               "$ref": "#/definitions/ReportParams"
 158             }
 159           }
 160         ],
 161         "responses": {
 162           "201": {
 163             "description": "Subscription successfully created",
 164             "schema": {
 165               "$ref": "#/definitions/SubscriptionResult"
 166             }
 167           },
 168           "400": {
 169             "description": "Invalid input"
 170           },
 171           "500": {
 172             "description": "Internal error"
 173           }
 174         }
 175       }
 176     },
 177     "/subscriptions/{subscriptionId}": {
 178       "delete": {
 179         "tags": [
 180           "common"
 181         ],
 182         "summary": "Unsubscribe X2AP events from Subscription Manager",
 183         "operationId": "Unsubscribe",
 184         "parameters": [
 185           {
 186             "type": "integer",
 187             "description": "The subscriptionId to be unsubscribed",
 188             "name": "subscriptionId",
 189             "in": "path",
 190             "required": true
 191           }
 192         ],
 193         "responses": {
 194           "204": {
 195             "description": "Operation done successfully"
 196           },
 197           "400": {
 198             "description": "Invalid requestorId supplied"
 199           },
 200           "500": {
 201             "description": "Internal error"
 202           }
 203         }
 204       }
 205     }
 206   },
 207   "definitions": {
 208     "ControlParams": {
 209       "type": "object",
 210       "properties": {
 211         "RequestorId": {
 212           "type": "integer"
 213         },
 214         "TBD": {
 215           "type": "string"
 216         }
 217       }
 218     },
 219     "EventTrigger": {
 220       "type": "object",
 221       "required": [
 222         "InterfaceDirection",
 223         "ProcedureCode",
 224         "TypeOfMessage"
 225       ],
 226       "properties": {
 227         "ENBId": {
 228           "type": "integer"
 229         },
 230         "InterfaceDirection": {
 231           "type": "integer"
 232         },
 233         "PlmnId": {
 234           "type": "string"
 235         },
 236         "ProcedureCode": {
 237           "type": "integer"
 238         },
 239         "TypeOfMessage": {
 240           "type": "integer"
 241         }
 242       }
 243     },
 244     "EventTriggerList": {
 245       "type": "array",
 246       "items": {
 247         "$ref": "#/definitions/EventTrigger"
 248       }
 249     },
 250     "PolicyParams": {
 251       "type": "object",
 252       "properties": {
 253         "RequestorId": {
 254           "type": "integer"
 255         },
 256         "TBD": {
 257           "type": "string"
 258         }
 259       }
 260     },
 261     "ReportParams": {
 262       "type": "object",
 263       "required": [
 264         "RequestorId",
 265         "EventTriggers"
 266       ],
 267       "properties": {
 268         "EventTriggers": {
 269           "$ref": "#/definitions/EventTriggerList"
 270         },
 271         "RequestorId": {
 272           "type": "integer"
 273         }
 274       }
 275     },
 276     "SubscriptionData": {
 277       "type": "object",
 278       "properties": {
 279         "Endpoint": {
 280           "type": "array",
 281           "items": {
 282             "type": "string"
 283           }
 284         },
 285         "Meid": {
 286           "type": "string"
 287         },
 288         "SubscriptionId": {
 289           "type": "integer"
 290         }
 291       }
 292     },
 293     "SubscriptionList": {
 294       "description": "A list of subscriptions",
 295       "type": "array",
 296       "items": {
 297         "$ref": "#/definitions/SubscriptionData"
 298       }
 299     },
 300     "SubscriptionResult": {
 301       "description": "A list of unique IDs",
 302       "type": "array",
 303       "items": {
 304         "type": "integer"
 305       }
 306     },
 307     "SubscriptionType": {
 308       "type": "string",
 309       "enum": [
 310         "control",
 311         "insert",
 312         "policy",
 313         "report"
 314       ]
 315     }
 316   }
 317 }`))
 318         FlatSwaggerJSON = json.RawMessage([]byte(`{
 319   "schemes": [
 320     "http"
 321   ],
 322   "swagger": "2.0",
 323   "info": {
 324     "description": "This is the initial REST API for RIC subscription",
 325     "title": "RIC subscription",
 326     "license": {
 327       "name": "Apache 2.0",
 328       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
 329     },
 330     "version": "0.0.1"
 331   },
 332   "host": "hostname",
 333   "basePath": "/ric/v1",
 334   "paths": {
 335     "/subscriptions": {
 336       "get": {
 337         "produces": [
 338           "application/json"
 339         ],
 340         "tags": [
 341           "query"
 342         ],
 343         "summary": "Returns list of subscriptions",
 344         "operationId": "getAllSubscriptions",
 345         "responses": {
 346           "200": {
 347             "description": "successful query of subscriptions",
 348             "schema": {
 349               "$ref": "#/definitions/SubscriptionList"
 350             }
 351           },
 352           "500": {
 353             "description": "Internal error"
 354           }
 355         }
 356       }
 357     },
 358     "/subscriptions/control": {
 359       "post": {
 360         "consumes": [
 361           "application/json"
 362         ],
 363         "produces": [
 364           "application/json"
 365         ],
 366         "tags": [
 367           "control"
 368         ],
 369         "summary": "Subscribe and send \"CONTROL\" message to RAN to initiate or resume call processing in RAN",
 370         "operationId": "subscribeControl",
 371         "parameters": [
 372           {
 373             "description": "Subscription control parameters",
 374             "name": "ControlParams",
 375             "in": "body",
 376             "schema": {
 377               "$ref": "#/definitions/ControlParams"
 378             }
 379           }
 380         ],
 381         "responses": {
 382           "201": {
 383             "description": "Subscription successfully created",
 384             "schema": {
 385               "$ref": "#/definitions/SubscriptionResult"
 386             }
 387           },
 388           "400": {
 389             "description": "Invalid input"
 390           },
 391           "500": {
 392             "description": "Internal error"
 393           }
 394         }
 395       }
 396     },
 397     "/subscriptions/policy": {
 398       "post": {
 399         "consumes": [
 400           "application/json"
 401         ],
 402         "produces": [
 403           "application/json"
 404         ],
 405         "tags": [
 406           "policy"
 407         ],
 408         "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",
 409         "operationId": "subscribePolicy",
 410         "parameters": [
 411           {
 412             "description": "Subscription policy parameters",
 413             "name": "PolicyParams",
 414             "in": "body",
 415             "schema": {
 416               "$ref": "#/definitions/PolicyParams"
 417             }
 418           }
 419         ],
 420         "responses": {
 421           "201": {
 422             "description": "Subscription successfully created",
 423             "schema": {
 424               "$ref": "#/definitions/SubscriptionResult"
 425             }
 426           },
 427           "400": {
 428             "description": "Invalid input"
 429           },
 430           "500": {
 431             "description": "Internal error"
 432           }
 433         }
 434       }
 435     },
 436     "/subscriptions/report": {
 437       "post": {
 438         "consumes": [
 439           "application/json"
 440         ],
 441         "produces": [
 442           "application/json"
 443         ],
 444         "tags": [
 445           "report"
 446         ],
 447         "summary": "Subscribe a list of X2AP event triggers to receive \"REPORT\" messages sent by RAN",
 448         "operationId": "subscribeReport",
 449         "parameters": [
 450           {
 451             "description": "Subscription report parameters",
 452             "name": "ReportParams",
 453             "in": "body",
 454             "schema": {
 455               "$ref": "#/definitions/ReportParams"
 456             }
 457           }
 458         ],
 459         "responses": {
 460           "201": {
 461             "description": "Subscription successfully created",
 462             "schema": {
 463               "$ref": "#/definitions/SubscriptionResult"
 464             }
 465           },
 466           "400": {
 467             "description": "Invalid input"
 468           },
 469           "500": {
 470             "description": "Internal error"
 471           }
 472         }
 473       }
 474     },
 475     "/subscriptions/{subscriptionId}": {
 476       "delete": {
 477         "tags": [
 478           "common"
 479         ],
 480         "summary": "Unsubscribe X2AP events from Subscription Manager",
 481         "operationId": "Unsubscribe",
 482         "parameters": [
 483           {
 484             "type": "integer",
 485             "description": "The subscriptionId to be unsubscribed",
 486             "name": "subscriptionId",
 487             "in": "path",
 488             "required": true
 489           }
 490         ],
 491         "responses": {
 492           "204": {
 493             "description": "Operation done successfully"
 494           },
 495           "400": {
 496             "description": "Invalid requestorId supplied"
 497           },
 498           "500": {
 499             "description": "Internal error"
 500           }
 501         }
 502       }
 503     }
 504   },
 505   "definitions": {
 506     "ControlParams": {
 507       "type": "object",
 508       "properties": {
 509         "RequestorId": {
 510           "type": "integer"
 511         },
 512         "TBD": {
 513           "type": "string"
 514         }
 515       }
 516     },
 517     "EventTrigger": {
 518       "type": "object",
 519       "required": [
 520         "InterfaceDirection",
 521         "ProcedureCode",
 522         "TypeOfMessage"
 523       ],
 524       "properties": {
 525         "ENBId": {
 526           "type": "integer"
 527         },
 528         "InterfaceDirection": {
 529           "type": "integer"
 530         },
 531         "PlmnId": {
 532           "type": "string"
 533         },
 534         "ProcedureCode": {
 535           "type": "integer"
 536         },
 537         "TypeOfMessage": {
 538           "type": "integer"
 539         }
 540       }
 541     },
 542     "EventTriggerList": {
 543       "type": "array",
 544       "items": {
 545         "$ref": "#/definitions/EventTrigger"
 546       }
 547     },
 548     "PolicyParams": {
 549       "type": "object",
 550       "properties": {
 551         "RequestorId": {
 552           "type": "integer"
 553         },
 554         "TBD": {
 555           "type": "string"
 556         }
 557       }
 558     },
 559     "ReportParams": {
 560       "type": "object",
 561       "required": [
 562         "RequestorId",
 563         "EventTriggers"
 564       ],
 565       "properties": {
 566         "EventTriggers": {
 567           "$ref": "#/definitions/EventTriggerList"
 568         },
 569         "RequestorId": {
 570           "type": "integer"
 571         }
 572       }
 573     },
 574     "SubscriptionData": {
 575       "type": "object",
 576       "properties": {
 577         "Endpoint": {
 578           "type": "array",
 579           "items": {
 580             "type": "string"
 581           }
 582         },
 583         "Meid": {
 584           "type": "string"
 585         },
 586         "SubscriptionId": {
 587           "type": "integer"
 588         }
 589       }
 590     },
 591     "SubscriptionList": {
 592       "description": "A list of subscriptions",
 593       "type": "array",
 594       "items": {
 595         "$ref": "#/definitions/SubscriptionData"
 596       }
 597     },
 598     "SubscriptionResult": {
 599       "description": "A list of unique IDs",
 600       "type": "array",
 601       "items": {
 602         "type": "integer"
 603       }
 604     },
 605     "SubscriptionType": {
 606       "type": "string",
 607       "enum": [
 608         "control",
 609         "insert",
 610         "policy",
 611         "report"
 612       ]
 613     }
 614   }
 615 }`))
 616 }