Updated documentation for mock a1 tool
[ric-app/admin.git] / init / schema.json
1 {
2   "definitions": {},
3   "$schema": "http://json-schema.org/draft-07/schema#",
4   "$id": "http://example.com/root.json",
5   "type": "object",
6   "title": "The Root Schema",
7   "required": [
8     "service_ports",
9     "rmr",
10     "envs"
11   ],
12   "properties": {
13     "service_ports": {
14       "$id": "#/properties/service_ports",
15       "type": "object",
16       "title": "The Service_ports Schema",
17       "required": [
18         "xapp_port",
19         "rmr_port"
20       ],
21       "properties": {
22         "xapp_port": {
23           "$id": "#/properties/service_ports/properties/xapp_port",
24           "type": "integer",
25           "title": "The Xapp_port Schema",
26           "default": 0,
27           "examples": [
28             4560
29           ]
30         },
31         "rmr_port": {
32           "$id": "#/properties/service_ports/properties/rmr_port",
33           "type": "integer",
34           "title": "The Rmr_port Schema",
35           "default": 0,
36           "examples": [
37             4561
38           ]
39         }
40       }
41     },
42     "rmr": {
43       "$id": "#/properties/rmr",
44       "type": "object",
45       "title": "The Rmr Schema",
46       "required": [
47         "protPort",
48         "maxSize",
49         "numWorkers",
50         "txMessages",
51         "rxMessages",
52         "file_path",
53         "contents"
54       ],
55       "properties": {
56         "protPort": {
57           "$id": "#/properties/rmr/properties/protPort",
58           "type": "string",
59           "title": "The Protport Schema",
60           "default": "",
61           "examples": [
62             "tcp:4560"
63           ],
64           "pattern": "^(.*)$"
65         },
66         "maxSize": {
67           "$id": "#/properties/rmr/properties/maxSize",
68           "type": "integer",
69           "title": "The Maxsize Schema",
70           "default": 0,
71           "examples": [
72             2072
73           ]
74         },
75         "numWorkers": {
76           "$id": "#/properties/rmr/properties/numWorkers",
77           "type": "integer",
78           "title": "The Numworkers Schema",
79           "default": 0,
80           "examples": [
81             1
82           ]
83         },
84         "txMessages": {
85           "$id": "#/properties/rmr/properties/txMessages",
86           "type": "array",
87           "title": "The Txmessages Schema",
88           "items": {
89             "$id": "#/properties/rmr/properties/txMessages/items",
90             "type": "string",
91             "title": "The Items Schema",
92             "default": "",
93             "examples": [
94               "RIC_SUB_REQ",
95               "RIC_SUB_DEL_REQ"
96             ],
97             "pattern": "^(.*)$"
98           }
99         },
100         "rxMessages": {
101           "$id": "#/properties/rmr/properties/rxMessages",
102           "type": "array",
103           "title": "The Rxmessages Schema",
104           "items": {
105             "$id": "#/properties/rmr/properties/rxMessages/items",
106             "type": "string",
107             "title": "The Items Schema",
108             "default": "",
109             "examples": [
110               "RIC_SUB_RESP",
111               "RIC_SUB_FAILURE",
112               "RIC_SUB_DEL_RESP",
113               "RIC_SUB_DEL_FAILURE",
114               "RIC_INDICATION"
115             ],
116             "pattern": "^(.*)$"
117           }
118         },
119         "file_path": {
120           "$id": "#/properties/rmr/properties/file_path",
121           "type": "string",
122           "title": "The File_path Schema",
123           "default": "",
124           "examples": [
125             "/tmp/routeinfo/routes.txt"
126           ],
127           "pattern": "^(.*)$"
128         },
129         "contents": {
130           "$id": "#/properties/rmr/properties/contents",
131           "type": "string",
132           "title": "The Contents Schema",
133           "default": "",
134           "examples": [
135             "newrt|start\nrte|0|localhost:4560\nrte|2|localhost:4591\nrte|10002|localhost:4560\nrte|10005|localhost:4560\nrte|10003|localhost:4591\nrte|12010|localhost:4591\nrte|12020|localhost:4591\nrte|12011|localhost:4560\nrte|12012|localhost:4560\nrte|12021|localhost:4560\nrte|12022|localhost:4560\nrte|20000|localhost:4560\nrte|20001|localhost:4566\nnewrt|end "
136           ],
137           "pattern": "^(.*)$"
138         }
139       }
140     },
141     "envs": {
142       "$id": "#/properties/envs",
143       "type": "object",
144       "title": "The Envs Schema",
145       "required": [
146         "gNodeB",
147         "THREADS",
148         "A1_SCHEMA_FILE",
149         "VES_SCHEMA_FILE",
150         "SAMPLE_FILE",
151         "VES_COLLECTOR_URL",
152         "VES_MEAUSUREMENT_INTERVAL"
153       ],
154       "properties": {
155         "gNodeB": {
156           "$id": "#/properties/envs/properties/gNodeB",
157           "type": "string",
158           "title": "The Gnodeb Schema",
159           "default": "",
160           "examples": [
161             "NYC123"
162           ],
163           "pattern": "^(.*)$"
164         },
165         "THREADS": {
166           "$id": "#/properties/envs/properties/THREADS",
167           "type": "string",
168           "title": "The Threads Schema",
169           "default": "",
170           "examples": [
171             "1"
172           ],
173           "pattern": "^(.*)$"
174         },
175         "A1_SCHEMA_FILE": {
176           "$id": "#/properties/envs/properties/A1_SCHEMA_FILE",
177           "type": "string",
178           "title": "The A1_schema_file Schema",
179           "default": "",
180           "examples": [
181             "/etc/xapp/adm-ctrl-xapp-schema.json"
182           ],
183           "pattern": "^(.*)$"
184         },
185         "VES_SCHEMA_FILE": {
186           "$id": "#/properties/envs/properties/VES_SCHEMA_FILE",
187           "type": "string",
188           "title": "The Ves_schema_file Schema",
189           "default": "",
190           "examples": [
191             "/etc/xapp/ves_schema.json"
192           ],
193           "pattern": "^(.*)$"
194         },
195         "SAMPLE_FILE": {
196           "$id": "#/properties/envs/properties/SAMPLE_FILE",
197           "type": "string",
198           "title": "The Sample_file Schema",
199           "default": "",
200           "examples": [
201             "/etc/xapp/samples.json"
202           ],
203           "pattern": "^(.*)$"
204         },
205         "VES_COLLECTOR_URL": {
206           "$id": "#/properties/envs/properties/VES_COLLECTOR_URL",
207           "type": "string",
208           "title": "The Ves_collector_url Schema",
209           "default": "",
210           "examples": [
211             "127.0.0.1:6350"
212           ],
213           "pattern": "^(.*)$"
214         },
215         "VES_MEAUSUREMENT_INTERVAL": {
216           "$id": "#/properties/envs/properties/VES_MEAUSUREMENT_INTERVAL",
217           "type": "string",
218           "title": "The Ves_meausurement_interval Schema",
219           "default": "",
220           "examples": [
221             "10"
222           ],
223           "pattern": "^(.*)$"
224         }
225       }
226     }
227   }
228 }
229