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