stats: golang vpp_if_stats_client
[vpp.git] / extras / vpp_if_stats / response_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     "vpp_details",
9     "interfaces"
10   ],
11   "properties": {
12     "vpp_details": {
13       "$id": "#/properties/vpp_details",
14       "type": "object",
15       "title": "The Vpp_details Schema",
16       "required": [
17         "program",
18         "version",
19         "build_date",
20         "build_directory"
21       ],
22       "properties": {
23         "program": {
24           "$id": "#/properties/vpp_details/properties/program",
25           "type": "string",
26           "title": "The Program Schema",
27           "default": "",
28           "examples": [
29             "vpe"
30           ],
31           "pattern": "^(.*)$"
32         },
33         "version": {
34           "$id": "#/properties/vpp_details/properties/version",
35           "type": "string",
36           "title": "The Version Schema",
37           "default": "",
38           "examples": [
39             "18.10-release"
40           ],
41           "pattern": "^(.*)$"
42         },
43         "build_date": {
44           "$id": "#/properties/vpp_details/properties/build_date",
45           "type": "string",
46           "title": "The Build_date Schema",
47           "default": "",
48           "examples": [
49             "Tue Oct 23 07:03:38 UTC 2018"
50           ],
51           "pattern": "^(.*)$"
52         },
53         "build_directory": {
54           "$id": "#/properties/vpp_details/properties/build_directory",
55           "type": "string",
56           "title": "The Build_directory Schema",
57           "default": "",
58           "examples": [
59             "/w/workspace/vpp-merge-1810-centos7"
60           ],
61           "pattern": "^(.*)$"
62         }
63       }
64     },
65     "interfaces": {
66       "$id": "#/properties/interfaces",
67       "type": "array",
68       "title": "The Interfaces Schema",
69       "items": {
70         "$id": "#/properties/interfaces/items",
71         "type": "object",
72         "title": "The Items Schema",
73         "required": [
74           "if_index",
75           "if_name",
76           "if_tag",
77           "if_mac",
78           "if_admin_state",
79           "if_link_state",
80           "if_link_mtu",
81           "if_sub_dot1ad",
82           "if_sub_id",
83           "if_tx_bytes",
84           "if_tx_packets",
85           "if_tx_errors",
86           "if_rx_bytes",
87           "if_rx_packets",
88           "if_rx_errors",
89           "if_drops",
90           "if_punts"
91         ],
92         "properties": {
93           "if_index": {
94             "$id": "#/properties/interfaces/items/properties/if_index",
95             "type": "integer",
96             "title": "The If_index Schema",
97             "default": 0,
98             "examples": [
99               0
100             ]
101           },
102           "if_name": {
103             "$id": "#/properties/interfaces/items/properties/if_name",
104             "type": "string",
105             "title": "The If_name Schema",
106             "default": "",
107             "examples": [
108               "local0"
109             ],
110             "pattern": "^(.*)$"
111           },
112           "if_tag": {
113             "$id": "#/properties/interfaces/items/properties/if_tag",
114             "type": "string",
115             "title": "The If_tag Schema",
116             "default": "",
117             "examples": [
118               ""
119             ],
120             "pattern": "^(.*)$"
121           },
122           "if_mac": {
123             "$id": "#/properties/interfaces/items/properties/if_mac",
124             "type": "string",
125             "title": "The If_mac Schema",
126             "default": "",
127             "examples": [
128               ""
129             ],
130             "pattern": "^(.*)$"
131           },
132           "if_admin_state": {
133             "$id": "#/properties/interfaces/items/properties/if_admin_state",
134             "type": "integer",
135             "title": "The If_admin_state Schema",
136             "default": 0,
137             "examples": [
138               0
139             ]
140           },
141           "if_link_state": {
142             "$id": "#/properties/interfaces/items/properties/if_link_state",
143             "type": "integer",
144             "title": "The If_link_state Schema",
145             "default": 0,
146             "examples": [
147               0
148             ]
149           },
150           "if_link_mtu": {
151             "$id": "#/properties/interfaces/items/properties/if_link_mtu",
152             "type": "integer",
153             "title": "The If_link_mtu Schema",
154             "default": 0,
155             "examples": [
156               0
157             ]
158           },
159           "if_sub_dot1ad": {
160             "$id": "#/properties/interfaces/items/properties/if_sub_dot1ad",
161             "type": "integer",
162             "title": "The If_sub_dot1ad Schema",
163             "default": 0,
164             "examples": [
165               0
166             ]
167           },
168           "if_sub_id": {
169             "$id": "#/properties/interfaces/items/properties/if_sub_id",
170             "type": "integer",
171             "title": "The If_sub_id Schema",
172             "default": 0,
173             "examples": [
174               0
175             ]
176           },
177           "if_tx_bytes": {
178             "$id": "#/properties/interfaces/items/properties/if_tx_bytes",
179             "type": "integer",
180             "title": "The If_tx_bytes Schema",
181             "default": 0,
182             "examples": [
183               0
184             ]
185           },
186           "if_tx_packets": {
187             "$id": "#/properties/interfaces/items/properties/if_tx_packets",
188             "type": "integer",
189             "title": "The If_tx_packets Schema",
190             "default": 0,
191             "examples": [
192               0
193             ]
194           },
195           "if_tx_errors": {
196             "$id": "#/properties/interfaces/items/properties/if_tx_errors",
197             "type": "integer",
198             "title": "The If_tx_errors Schema",
199             "default": 0,
200             "examples": [
201               0
202             ]
203           },
204           "if_rx_bytes": {
205             "$id": "#/properties/interfaces/items/properties/if_rx_bytes",
206             "type": "integer",
207             "title": "The If_rx_bytes Schema",
208             "default": 0,
209             "examples": [
210               0
211             ]
212           },
213           "if_rx_packets": {
214             "$id": "#/properties/interfaces/items/properties/if_rx_packets",
215             "type": "integer",
216             "title": "The If_rx_packets Schema",
217             "default": 0,
218             "examples": [
219               0
220             ]
221           },
222           "if_rx_errors": {
223             "$id": "#/properties/interfaces/items/properties/if_rx_errors",
224             "type": "integer",
225             "title": "The If_rx_errors Schema",
226             "default": 0,
227             "examples": [
228               0
229             ]
230           },
231           "if_drops": {
232             "$id": "#/properties/interfaces/items/properties/if_drops",
233             "type": "integer",
234             "title": "The If_drops Schema",
235             "default": 0,
236             "examples": [
237               0
238             ]
239           },
240           "if_punts": {
241             "$id": "#/properties/interfaces/items/properties/if_punts",
242             "type": "integer",
243             "title": "The If_punts Schema",
244             "default": 0,
245             "examples": [
246               0
247             ]
248           }
249         }
250       }
251     }
252   }
253 }