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/policy": {
  61       "post": {
  62         "consumes": [
  63           "application/json"
  64         ],
  65         "produces": [
  66           "application/json"
  67         ],
  68         "tags": [
  69           "policy"
  70         ],
  71         "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",
  72         "operationId": "subscribePolicy",
  73         "parameters": [
  74           {
  75             "description": "Subscription policy parameters",
  76             "name": "PolicyParams",
  77             "in": "body",
  78             "schema": {
  79               "$ref": "#/definitions/PolicyParams"
  80             }
  81           }
  82         ],
  83         "responses": {
  84           "201": {
  85             "description": "Subscription successfully created",
  86             "schema": {
  87               "$ref": "#/definitions/SubscriptionResponse"
  88             }
  89           },
  90           "400": {
  91             "description": "Invalid input"
  92           },
  93           "500": {
  94             "description": "Internal error"
  95           }
  96         }
  97       }
  98     },
  99     "/subscriptions/report": {
 100       "post": {
 101         "consumes": [
 102           "application/json"
 103         ],
 104         "produces": [
 105           "application/json"
 106         ],
 107         "tags": [
 108           "report"
 109         ],
 110         "summary": "Subscribe a list of X2AP event triggers to receive \"REPORT\" messages sent by RAN or Subscribe to receive the content of gNB NRT table in REPORT message sent by RAN",
 111         "operationId": "subscribeReport",
 112         "parameters": [
 113           {
 114             "description": "Subscription report parameters",
 115             "name": "ReportParams",
 116             "in": "body",
 117             "schema": {
 118               "$ref": "#/definitions/ReportParams"
 119             }
 120           }
 121         ],
 122         "responses": {
 123           "201": {
 124             "description": "Subscription successfully created",
 125             "schema": {
 126               "$ref": "#/definitions/SubscriptionResponse"
 127             }
 128           },
 129           "400": {
 130             "description": "Invalid input"
 131           },
 132           "500": {
 133             "description": "Internal error"
 134           }
 135         }
 136       }
 137     },
 138     "/subscriptions/{subscriptionId}": {
 139       "delete": {
 140         "tags": [
 141           "common"
 142         ],
 143         "summary": "Unsubscribe X2AP events from Subscription Manager",
 144         "operationId": "Unsubscribe",
 145         "parameters": [
 146           {
 147             "type": "string",
 148             "description": "The subscriptionId received in the Subscription Response",
 149             "name": "subscriptionId",
 150             "in": "path",
 151             "required": true
 152           }
 153         ],
 154         "responses": {
 155           "204": {
 156             "description": "Operation done successfully"
 157           },
 158           "400": {
 159             "description": "Invalid subscriptionId supplied"
 160           },
 161           "500": {
 162             "description": "Internal error"
 163           }
 164         }
 165       }
 166     }
 167   },
 168   "definitions": {
 169     "ActionParameters": {
 170       "type": "object",
 171       "required": [
 172         "ActionParameterID",
 173         "ActionParameterValue"
 174       ],
 175       "properties": {
 176         "ActionParameterID": {
 177           "type": "integer"
 178         },
 179         "ActionParameterValue": {
 180           "type": "boolean"
 181         }
 182       }
 183     },
 184     "EventTrigger": {
 185       "type": "object",
 186       "properties": {
 187         "ENBId": {
 188           "type": "string"
 189         },
 190         "InterfaceDirection": {
 191           "type": "integer"
 192         },
 193         "PlmnId": {
 194           "type": "string"
 195         },
 196         "ProcedureCode": {
 197           "type": "integer"
 198         },
 199         "TriggerNature": {
 200           "type": "string",
 201           "enum": [
 202             "now",
 203             "on change"
 204           ]
 205         },
 206         "TypeOfMessage": {
 207           "type": "integer"
 208         }
 209       }
 210     },
 211     "EventTriggerList": {
 212       "type": "array",
 213       "items": {
 214         "$ref": "#/definitions/EventTrigger"
 215       }
 216     },
 217     "Format1ActionDefinition": {
 218       "type": "object",
 219       "required": [
 220         "StyleID",
 221         "ActionParameters"
 222       ],
 223       "properties": {
 224         "ActionParameters": {
 225           "type": "array",
 226           "items": {
 227             "$ref": "#/definitions/ActionParameters"
 228           }
 229         },
 230         "StyleID": {
 231           "type": "integer"
 232         }
 233       }
 234     },
 235     "Format2ActionDefinition": {
 236       "type": "object",
 237       "required": [
 238         "RANUeGroupParameters"
 239       ],
 240       "properties": {
 241         "RANUeGroupParameters": {
 242           "type": "array",
 243           "items": {
 244             "$ref": "#/definitions/RANUeGroupList"
 245           }
 246         }
 247       }
 248     },
 249     "ImperativePolicyDefinition": {
 250       "type": "object",
 251       "required": [
 252         "PolicyParameterID",
 253         "PolicyParameterValue"
 254       ],
 255       "properties": {
 256         "PolicyParameterID": {
 257           "type": "integer"
 258         },
 259         "PolicyParameterValue": {
 260           "type": "integer"
 261         }
 262       }
 263     },
 264     "PolicyActionDefinition": {
 265       "type": "object",
 266       "properties": {
 267         "ActionDefinitionFormat2": {
 268           "$ref": "#/definitions/Format2ActionDefinition"
 269         }
 270       }
 271     },
 272     "PolicyParams": {
 273       "type": "object",
 274       "required": [
 275         "Meid",
 276         "RANFunctionID",
 277         "ClientEndpoint",
 278         "EventTriggers",
 279         "PolicyActionDefinitions"
 280       ],
 281       "properties": {
 282         "ClientEndpoint": {
 283           "type": "string"
 284         },
 285         "EventTriggers": {
 286           "$ref": "#/definitions/EventTriggerList"
 287         },
 288         "Meid": {
 289           "type": "string"
 290         },
 291         "PolicyActionDefinitions": {
 292           "$ref": "#/definitions/PolicyActionDefinition"
 293         },
 294         "RANFunctionID": {
 295           "type": "integer"
 296         }
 297       }
 298     },
 299     "RANUeGroupList": {
 300       "type": "object",
 301       "required": [
 302         "RANUeGroupID",
 303         "RANUeGroupDefinition",
 304         "RANImperativePolicy"
 305       ],
 306       "properties": {
 307         "RANImperativePolicy": {
 308           "$ref": "#/definitions/ImperativePolicyDefinition"
 309         },
 310         "RANUeGroupDefinition": {
 311           "$ref": "#/definitions/RANUeGroupParams"
 312         },
 313         "RANUeGroupID": {
 314           "type": "integer"
 315         }
 316       }
 317     },
 318     "RANUeGroupParams": {
 319       "type": "object",
 320       "required": [
 321         "RANParameterID",
 322         "RANParameterValue"
 323       ],
 324       "properties": {
 325         "RANParameterID": {
 326           "type": "integer"
 327         },
 328         "RANParameterTestCondition": {
 329           "type": "string",
 330           "enum": [
 331             "equal",
 332             "greaterthan",
 333             "lessthan",
 334             "contains",
 335             "present"
 336           ]
 337         },
 338         "RANParameterValue": {
 339           "type": "integer"
 340         }
 341       }
 342     },
 343     "ReportActionDefinition": {
 344       "type": "object",
 345       "properties": {
 346         "ActionDefinitionFormat1": {
 347           "$ref": "#/definitions/Format1ActionDefinition"
 348         }
 349       }
 350     },
 351     "ReportParams": {
 352       "type": "object",
 353       "required": [
 354         "RANFunctionID",
 355         "ClientEndpoint",
 356         "EventTriggers"
 357       ],
 358       "properties": {
 359         "ClientEndpoint": {
 360           "type": "string"
 361         },
 362         "EventTriggers": {
 363           "$ref": "#/definitions/EventTriggerList"
 364         },
 365         "Meid": {
 366           "type": "string"
 367         },
 368         "RANFunctionID": {
 369           "type": "integer"
 370         },
 371         "ReportActionDefinitions": {
 372           "$ref": "#/definitions/ReportActionDefinition"
 373         }
 374       }
 375     },
 376     "SubscriptionData": {
 377       "type": "object",
 378       "properties": {
 379         "Endpoint": {
 380           "type": "array",
 381           "items": {
 382             "type": "string"
 383           }
 384         },
 385         "Meid": {
 386           "type": "string"
 387         },
 388         "SubscriptionId": {
 389           "type": "integer"
 390         }
 391       }
 392     },
 393     "SubscriptionList": {
 394       "description": "A list of subscriptions",
 395       "type": "array",
 396       "items": {
 397         "$ref": "#/definitions/SubscriptionData"
 398       }
 399     },
 400     "SubscriptionResponse": {
 401       "type": "array",
 402       "items": {
 403         "$ref": "#/definitions/SubscriptionResponseItem"
 404       }
 405     },
 406     "SubscriptionResponseItem": {
 407       "type": "object",
 408       "required": [
 409         "SubscriptionId",
 410         "RequestorId",
 411         "InstanceId"
 412       ],
 413       "properties": {
 414         "InstanceId": {
 415           "type": "integer"
 416         },
 417         "RequestorId": {
 418           "type": "integer"
 419         },
 420         "SubscriptionId": {
 421           "type": "string"
 422         }
 423       }
 424     },
 425     "SubscriptionType": {
 426       "type": "string",
 427       "enum": [
 428         "insert",
 429         "policy",
 430         "report"
 431       ]
 432     }
 433   }
 434 }`))
 435         FlatSwaggerJSON = json.RawMessage([]byte(`{
 436   "schemes": [
 437     "http"
 438   ],
 439   "swagger": "2.0",
 440   "info": {
 441     "description": "This is the initial REST API for RIC subscription",
 442     "title": "RIC subscription",
 443     "license": {
 444       "name": "Apache 2.0",
 445       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
 446     },
 447     "version": "0.0.1"
 448   },
 449   "host": "hostname",
 450   "basePath": "/ric/v1",
 451   "paths": {
 452     "/subscriptions": {
 453       "get": {
 454         "produces": [
 455           "application/json"
 456         ],
 457         "tags": [
 458           "query"
 459         ],
 460         "summary": "Returns list of subscriptions",
 461         "operationId": "getAllSubscriptions",
 462         "responses": {
 463           "200": {
 464             "description": "successful query of subscriptions",
 465             "schema": {
 466               "$ref": "#/definitions/SubscriptionList"
 467             }
 468           },
 469           "500": {
 470             "description": "Internal error"
 471           }
 472         }
 473       }
 474     },
 475     "/subscriptions/policy": {
 476       "post": {
 477         "consumes": [
 478           "application/json"
 479         ],
 480         "produces": [
 481           "application/json"
 482         ],
 483         "tags": [
 484           "policy"
 485         ],
 486         "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",
 487         "operationId": "subscribePolicy",
 488         "parameters": [
 489           {
 490             "description": "Subscription policy parameters",
 491             "name": "PolicyParams",
 492             "in": "body",
 493             "schema": {
 494               "$ref": "#/definitions/PolicyParams"
 495             }
 496           }
 497         ],
 498         "responses": {
 499           "201": {
 500             "description": "Subscription successfully created",
 501             "schema": {
 502               "$ref": "#/definitions/SubscriptionResponse"
 503             }
 504           },
 505           "400": {
 506             "description": "Invalid input"
 507           },
 508           "500": {
 509             "description": "Internal error"
 510           }
 511         }
 512       }
 513     },
 514     "/subscriptions/report": {
 515       "post": {
 516         "consumes": [
 517           "application/json"
 518         ],
 519         "produces": [
 520           "application/json"
 521         ],
 522         "tags": [
 523           "report"
 524         ],
 525         "summary": "Subscribe a list of X2AP event triggers to receive \"REPORT\" messages sent by RAN or Subscribe to receive the content of gNB NRT table in REPORT message sent by RAN",
 526         "operationId": "subscribeReport",
 527         "parameters": [
 528           {
 529             "description": "Subscription report parameters",
 530             "name": "ReportParams",
 531             "in": "body",
 532             "schema": {
 533               "$ref": "#/definitions/ReportParams"
 534             }
 535           }
 536         ],
 537         "responses": {
 538           "201": {
 539             "description": "Subscription successfully created",
 540             "schema": {
 541               "$ref": "#/definitions/SubscriptionResponse"
 542             }
 543           },
 544           "400": {
 545             "description": "Invalid input"
 546           },
 547           "500": {
 548             "description": "Internal error"
 549           }
 550         }
 551       }
 552     },
 553     "/subscriptions/{subscriptionId}": {
 554       "delete": {
 555         "tags": [
 556           "common"
 557         ],
 558         "summary": "Unsubscribe X2AP events from Subscription Manager",
 559         "operationId": "Unsubscribe",
 560         "parameters": [
 561           {
 562             "type": "string",
 563             "description": "The subscriptionId received in the Subscription Response",
 564             "name": "subscriptionId",
 565             "in": "path",
 566             "required": true
 567           }
 568         ],
 569         "responses": {
 570           "204": {
 571             "description": "Operation done successfully"
 572           },
 573           "400": {
 574             "description": "Invalid subscriptionId supplied"
 575           },
 576           "500": {
 577             "description": "Internal error"
 578           }
 579         }
 580       }
 581     }
 582   },
 583   "definitions": {
 584     "ActionParameters": {
 585       "type": "object",
 586       "required": [
 587         "ActionParameterID",
 588         "ActionParameterValue"
 589       ],
 590       "properties": {
 591         "ActionParameterID": {
 592           "type": "integer"
 593         },
 594         "ActionParameterValue": {
 595           "type": "boolean"
 596         }
 597       }
 598     },
 599     "EventTrigger": {
 600       "type": "object",
 601       "properties": {
 602         "ENBId": {
 603           "type": "string"
 604         },
 605         "InterfaceDirection": {
 606           "type": "integer"
 607         },
 608         "PlmnId": {
 609           "type": "string"
 610         },
 611         "ProcedureCode": {
 612           "type": "integer"
 613         },
 614         "TriggerNature": {
 615           "type": "string",
 616           "enum": [
 617             "now",
 618             "on change"
 619           ]
 620         },
 621         "TypeOfMessage": {
 622           "type": "integer"
 623         }
 624       }
 625     },
 626     "EventTriggerList": {
 627       "type": "array",
 628       "items": {
 629         "$ref": "#/definitions/EventTrigger"
 630       }
 631     },
 632     "Format1ActionDefinition": {
 633       "type": "object",
 634       "required": [
 635         "StyleID",
 636         "ActionParameters"
 637       ],
 638       "properties": {
 639         "ActionParameters": {
 640           "type": "array",
 641           "items": {
 642             "$ref": "#/definitions/ActionParameters"
 643           }
 644         },
 645         "StyleID": {
 646           "type": "integer"
 647         }
 648       }
 649     },
 650     "Format2ActionDefinition": {
 651       "type": "object",
 652       "required": [
 653         "RANUeGroupParameters"
 654       ],
 655       "properties": {
 656         "RANUeGroupParameters": {
 657           "type": "array",
 658           "items": {
 659             "$ref": "#/definitions/RANUeGroupList"
 660           }
 661         }
 662       }
 663     },
 664     "ImperativePolicyDefinition": {
 665       "type": "object",
 666       "required": [
 667         "PolicyParameterID",
 668         "PolicyParameterValue"
 669       ],
 670       "properties": {
 671         "PolicyParameterID": {
 672           "type": "integer"
 673         },
 674         "PolicyParameterValue": {
 675           "type": "integer"
 676         }
 677       }
 678     },
 679     "PolicyActionDefinition": {
 680       "type": "object",
 681       "properties": {
 682         "ActionDefinitionFormat2": {
 683           "$ref": "#/definitions/Format2ActionDefinition"
 684         }
 685       }
 686     },
 687     "PolicyParams": {
 688       "type": "object",
 689       "required": [
 690         "Meid",
 691         "RANFunctionID",
 692         "ClientEndpoint",
 693         "EventTriggers",
 694         "PolicyActionDefinitions"
 695       ],
 696       "properties": {
 697         "ClientEndpoint": {
 698           "type": "string"
 699         },
 700         "EventTriggers": {
 701           "$ref": "#/definitions/EventTriggerList"
 702         },
 703         "Meid": {
 704           "type": "string"
 705         },
 706         "PolicyActionDefinitions": {
 707           "$ref": "#/definitions/PolicyActionDefinition"
 708         },
 709         "RANFunctionID": {
 710           "type": "integer"
 711         }
 712       }
 713     },
 714     "RANUeGroupList": {
 715       "type": "object",
 716       "required": [
 717         "RANUeGroupID",
 718         "RANUeGroupDefinition",
 719         "RANImperativePolicy"
 720       ],
 721       "properties": {
 722         "RANImperativePolicy": {
 723           "$ref": "#/definitions/ImperativePolicyDefinition"
 724         },
 725         "RANUeGroupDefinition": {
 726           "$ref": "#/definitions/RANUeGroupParams"
 727         },
 728         "RANUeGroupID": {
 729           "type": "integer"
 730         }
 731       }
 732     },
 733     "RANUeGroupParams": {
 734       "type": "object",
 735       "required": [
 736         "RANParameterID",
 737         "RANParameterValue"
 738       ],
 739       "properties": {
 740         "RANParameterID": {
 741           "type": "integer"
 742         },
 743         "RANParameterTestCondition": {
 744           "type": "string",
 745           "enum": [
 746             "equal",
 747             "greaterthan",
 748             "lessthan",
 749             "contains",
 750             "present"
 751           ]
 752         },
 753         "RANParameterValue": {
 754           "type": "integer"
 755         }
 756       }
 757     },
 758     "ReportActionDefinition": {
 759       "type": "object",
 760       "properties": {
 761         "ActionDefinitionFormat1": {
 762           "$ref": "#/definitions/Format1ActionDefinition"
 763         }
 764       }
 765     },
 766     "ReportParams": {
 767       "type": "object",
 768       "required": [
 769         "RANFunctionID",
 770         "ClientEndpoint",
 771         "EventTriggers"
 772       ],
 773       "properties": {
 774         "ClientEndpoint": {
 775           "type": "string"
 776         },
 777         "EventTriggers": {
 778           "$ref": "#/definitions/EventTriggerList"
 779         },
 780         "Meid": {
 781           "type": "string"
 782         },
 783         "RANFunctionID": {
 784           "type": "integer"
 785         },
 786         "ReportActionDefinitions": {
 787           "$ref": "#/definitions/ReportActionDefinition"
 788         }
 789       }
 790     },
 791     "SubscriptionData": {
 792       "type": "object",
 793       "properties": {
 794         "Endpoint": {
 795           "type": "array",
 796           "items": {
 797             "type": "string"
 798           }
 799         },
 800         "Meid": {
 801           "type": "string"
 802         },
 803         "SubscriptionId": {
 804           "type": "integer"
 805         }
 806       }
 807     },
 808     "SubscriptionList": {
 809       "description": "A list of subscriptions",
 810       "type": "array",
 811       "items": {
 812         "$ref": "#/definitions/SubscriptionData"
 813       }
 814     },
 815     "SubscriptionResponse": {
 816       "type": "array",
 817       "items": {
 818         "$ref": "#/definitions/SubscriptionResponseItem"
 819       }
 820     },
 821     "SubscriptionResponseItem": {
 822       "type": "object",
 823       "required": [
 824         "SubscriptionId",
 825         "RequestorId",
 826         "InstanceId"
 827       ],
 828       "properties": {
 829         "InstanceId": {
 830           "type": "integer"
 831         },
 832         "RequestorId": {
 833           "type": "integer"
 834         },
 835         "SubscriptionId": {
 836           "type": "string"
 837         }
 838       }
 839     },
 840     "SubscriptionType": {
 841       "type": "string",
 842       "enum": [
 843         "insert",
 844         "policy",
 845         "report"
 846       ]
 847     }
 848   }
 849 }`))
 850 }