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