Gitiles
Code Review Sign In
gerrit.onosproject.org / onos / b60b7a13d7faba709fd3fb6e37b157c59a778ec1 / . / web / api / src / main / resources / definitions / Groups.json
blob: 50b68506dc9eb6e69b28852811ddb59907edc935 [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 },
Varun Sharma1853b3f2016-07-18 14:37:13 +0530[diff] [blame]70 "deviceId": {
71 "type": "string",
72 "description": "device identifier",
73 "example": "of:0000000000000003"
74 },
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]75 "appId": {
76 "type": "string",
77 "description": "application identifier",
varunsha34b30602016-08-18 10:31:18 -0700[diff] [blame]78 "example": "org.onosproject.rest"
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]79 },
80 "appCookie": {
81 "type": "string",
82 "description": "application cookie",
Charles Chanb3ef1fd2016-05-12 20:49:39 -0700[diff] [blame]83 "example": "0x1234abcd"
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]84 },
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]85 "buckets": {
86 "type": "array",
87 "xml": {
88 "name": "buckets",
89 "wrapped": true
90 },
91 "items": {
92 "type": "object",
93 "title": "buckets",
94 "required": [
95 "treatment",
96 "weight",
97 "watchPort",
98 "watchGroup"
99 ],
100 "properties": {
101 "treatment": {
102 "type": "object",
103 "title": "treatment",
104 "required": [
105 "instructions",
106 "deferred"
107 ],
108 "properties": {
109 "instructions": {
110 "type": "array",
111 "title": "treatment",
112 "required": [
113 "properties",
114 "port"
115 ],
116 "items": {
117 "type": "object",
118 "title": "instructions",
119 "required": [
120 "type",
121 "port"
122 ],
123 "properties": {
124 "type": {
125 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]126 "description": "instruction type",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]127 "example": "OUTPUT"
128 },
129 "port": {
130 "type": "string",
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]131 "description": "port number",
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]132 "example": "2"
133 }
134 }
135 }
136 }
137 }
Jian Lia7f86ce2015-12-20 13:42:10 -0800[diff] [blame]138 },
139 "weight": {
140 "type": "integer",
141 "format": "int16",
142 "description": "weight of select group bucket",
143 "example": "1.0"
144 },
145 "watchPort": {
146 "type": "string",
147 "description": "port number used for liveness detection for a failover bucket",
148 "example": "2"
149 },
150 "watchGroup": {
151 "type": "string",
152 "description": "group identifier used for liveness detection for a failover bucket",
153 "example": "1"
Jian Liecb3c0f2015-12-15 10:07:49 -0800[diff] [blame]154 }
155 }
156 }
157 }
158 }
159 }
160 }
161 }
Varun Sharma1853b3f2016-07-18 14:37:13 +0530[diff] [blame]162}