Gitiles
Code Review Sign In
gerrit.onosproject.org / onos / a49aa03e70c01974065f0b1c5924a26a4ba8dac8 / . / web / api / src / main / resources / definitions / Groups.json
blob: e2be80731a1d1d319f0bcc4615f1e6c6bf60bea1 [file] [log] [blame]
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]1{
2 "type": "object",
3 "title": "groups",
4 "required": [
5 "groups"
6 ],
7 "properties": {
8 "groups": {
9 "type": "array",
10 "xml": {
11 "name": "groups",
12 "wrapped": true
13 },
14 "items": {
15 "type": "object",
16 "title": "group",
17 "required": [
18 "id",
19 "state",
20 "life",
21 "packets",
22 "bytes",
23 "referenceCount",
24 "type",
25 "deviceId",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]26 "appId",
27 "appCookie",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]28 "buckets"
29 ],
30 "properties": {
31 "id": {
32 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]33 "description": "group id",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]34 "example": "1"
35 },
36 "state": {
37 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]38 "description": "state of the group object",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]39 "example": "PENDING_ADD"
40 },
41 "life": {
42 "type": "integer",
43 "format": "int64",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]44 "description": "number of milliseconds this group has been alive",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]45 "example": 69889
46 },
47 "packets": {
48 "type": "integer",
49 "format": "int64",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]50 "description": "number of packets processed by this group",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]51 "example": 22546
52 },
53 "bytes": {
54 "type": "integer",
55 "format": "int64",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]56 "description": "number of bytes processed by this group",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]57 "example": 1826226
58 },
59 "referenceCount": {
60 "type": "integer",
61 "format": "int64",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]62 "description": "number of flow rules or other groups reference this group",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]63 "example": 1826226
64 },
65 "type": {
66 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]67 "description": "types of the group",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]68 "example": "ALL"
69 },
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]70 "appId": {
71 "type": "string",
72 "description": "application identifier",
73 "example": "1"
74 },
75 "appCookie": {
76 "type": "string",
77 "description": "application cookie",
Varun Sharmaa49aa032016-07-05 07:57:33 +0530[diff] [blame^]78 "example": "0x1234abcd"
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]79 },
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]80 "buckets": {
81 "type": "array",
82 "xml": {
83 "name": "buckets",
84 "wrapped": true
85 },
86 "items": {
87 "type": "object",
88 "title": "buckets",
89 "required": [
90 "treatment",
91 "weight",
92 "watchPort",
93 "watchGroup"
94 ],
95 "properties": {
96 "treatment": {
97 "type": "object",
98 "title": "treatment",
99 "required": [
100 "instructions",
101 "deferred"
102 ],
103 "properties": {
104 "instructions": {
105 "type": "array",
106 "title": "treatment",
107 "required": [
108 "properties",
109 "port"
110 ],
111 "items": {
112 "type": "object",
113 "title": "instructions",
114 "required": [
115 "type",
116 "port"
117 ],
118 "properties": {
119 "type": {
120 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]121 "description": "instruction type",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]122 "example": "OUTPUT"
123 },
124 "port": {
125 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]126 "description": "port number",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]127 "example": "2"
128 }
129 }
130 }
131 }
132 }
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]133 },
134 "weight": {
135 "type": "integer",
136 "format": "int16",
137 "description": "weight of select group bucket",
138 "example": "1.0"
139 },
140 "watchPort": {
141 "type": "string",
142 "description": "port number used for liveness detection for a failover bucket",
143 "example": "2"
144 },
145 "watchGroup": {
146 "type": "string",
147 "description": "group identifier used for liveness detection for a failover bucket",
148 "example": "1"
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]149 }
150 }
151 }
152 }
153 }
154 }
155 }
156 }
Varun Sharmaa49aa032016-07-05 07:57:33 +0530[diff] [blame^]157}