홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Jian Li
Committed by Gerrit Code Review
d86fac39 1 parent 1e0a586b

[ONOS-3663] Add swagger doc for control metrics query REST API 

Change-Id: Id8b667dabb64d11149b43cfeead57cf5ebd6997e
Inline Side-by-side
Showing 7 changed files with 834 additions and 0 deletions
...@@ -59,6 +59,7 @@ public class ControlMetricsWebResource extends AbstractWebResource { ...@@ -59,6 +59,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
59 * Returns control message metrics of all devices. 59 * Returns control message metrics of all devices.
60 * 60 *
61 * @return array of all control message metrics 61 * @return array of all control message metrics
62 + * @onos.rsModel ControlMessageMetrics
62 */ 63 */
63 @GET 64 @GET
64 @Path("messages") 65 @Path("messages")
...@@ -86,6 +87,7 @@ public class ControlMetricsWebResource extends AbstractWebResource { ...@@ -86,6 +87,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
86 * 87 *
87 * @param deviceId device identification 88 * @param deviceId device identification
88 * @return control message metrics of a given device 89 * @return control message metrics of a given device
90 + * @onos.rsModel ControlMessageMetric
89 */ 91 */
90 @GET 92 @GET
91 @Produces(MediaType.APPLICATION_JSON) 93 @Produces(MediaType.APPLICATION_JSON)
...@@ -102,6 +104,7 @@ public class ControlMetricsWebResource extends AbstractWebResource { ...@@ -102,6 +104,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
102 * Returns cpu metrics. 104 * Returns cpu metrics.
103 * 105 *
104 * @return cpu metrics 106 * @return cpu metrics
107 + * @onos.rsModel CpuMetrics
105 */ 108 */
106 @GET 109 @GET
107 @Path("cpu_metrics") 110 @Path("cpu_metrics")
...@@ -116,6 +119,7 @@ public class ControlMetricsWebResource extends AbstractWebResource { ...@@ -116,6 +119,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
116 * Returns memory metrics. 119 * Returns memory metrics.
117 * 120 *
118 * @return memory metrics 121 * @return memory metrics
122 + * @onos.rsModel MemoryMetrics
119 */ 123 */
120 @GET 124 @GET
121 @Path("memory_metrics") 125 @Path("memory_metrics")
...@@ -130,6 +134,7 @@ public class ControlMetricsWebResource extends AbstractWebResource { ...@@ -130,6 +134,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
130 * Returns disk metrics of all resources. 134 * Returns disk metrics of all resources.
131 * 135 *
132 * @return disk metrics of all resources 136 * @return disk metrics of all resources
137 + * @onos.rsModel DiskMetrics
133 */ 138 */
134 @GET 139 @GET
135 @Path("disk_metrics") 140 @Path("disk_metrics")
...@@ -155,6 +160,7 @@ public class ControlMetricsWebResource extends AbstractWebResource { ...@@ -155,6 +160,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
155 * Returns network metrics of all resources. 160 * Returns network metrics of all resources.
156 * 161 *
157 * @return network metrics of all resources 162 * @return network metrics of all resources
163 + * @onos.rsModel NetworkMetrics
158 */ 164 */
159 @GET 165 @GET
160 @Path("network_metrics") 166 @Path("network_metrics")
......
1 +{
2 + "type": "object",
3 + "title": "metrics",
4 + "required": [
5 + "metrics"
6 + ],
7 + "properties": {
8 + "metrics": {
9 + "type": "array",
10 + "xml": {
11 + "name": "metrics",
12 + "wrapped": true
13 + },
14 + "items": {
15 + "type": "object",
16 + "title": "metrics",
17 + "required": [
18 + "inboundPacket",
19 + "outboundPacket",
20 + "flowModPacket",
21 + "flowRemovedPacket",
22 + "requestPacket",
23 + "replyPacket"
24 + ],
25 + "properties": {
26 + "inboundPacket": {
27 + "type": "object",
28 + "required": [
29 + "time",
30 + "latest",
31 + "average"
32 + ],
33 + "properties": {
34 + "time": {
35 + "type": "integer",
36 + "format": "int64"
37 + },
38 + "latest": {
39 + "type": "integer",
40 + "format": "int64"
41 + },
42 + "average": {
43 + "type": "integer",
44 + "format": "int64"
45 + }
46 + }
47 + },
48 + "outboundPacket": {
49 + "type": "object",
50 + "required": [
51 + "time",
52 + "latest",
53 + "average"
54 + ],
55 + "properties": {
56 + "time": {
57 + "type": "integer",
58 + "format": "int64"
59 + },
60 + "latest": {
61 + "type": "integer",
62 + "format": "int64"
63 + },
64 + "average": {
65 + "type": "integer",
66 + "format": "int64"
67 + }
68 + }
69 + },
70 + "flowModPacket": {
71 + "type": "object",
72 + "required": [
73 + "time",
74 + "latest",
75 + "average"
76 + ],
77 + "properties": {
78 + "time": {
79 + "type": "integer",
80 + "format": "int64"
81 + },
82 + "latest": {
83 + "type": "integer",
84 + "format": "int64"
85 + },
86 + "average": {
87 + "type": "integer",
88 + "format": "int64"
89 + }
90 + }
91 + },
92 + "flowRemovedPacket": {
93 + "type": "object",
94 + "required": [
95 + "time",
96 + "latest",
97 + "average"
98 + ],
99 + "properties": {
100 + "time": {
101 + "type": "integer",
102 + "format": "int64"
103 + },
104 + "latest": {
105 + "type": "integer",
106 + "format": "int64"
107 + },
108 + "average": {
109 + "type": "integer",
110 + "format": "int64"
111 + }
112 + }
113 + },
114 + "requestPacket": {
115 + "type": "object",
116 + "required": [
117 + "time",
118 + "latest",
119 + "average"
120 + ],
121 + "properties": {
122 + "time": {
123 + "type": "integer",
124 + "format": "int64"
125 + },
126 + "latest": {
127 + "type": "integer",
128 + "format": "int64"
129 + },
130 + "average": {
131 + "type": "integer",
132 + "format": "int64"
133 + }
134 + }
135 + },
136 + "replyPacket": {
137 + "type": "object",
138 + "required": [
139 + "time",
140 + "latest",
141 + "average"
142 + ],
143 + "properties": {
144 + "time": {
145 + "type": "integer",
146 + "format": "int64"
147 + },
148 + "latest": {
149 + "type": "integer",
150 + "format": "int64"
151 + },
152 + "average": {
153 + "type": "integer",
154 + "format": "int64"
155 + }
156 + }
157 + }
158 + }
159 + }
160 + }
161 + }
162 +}
...\ No newline at end of file ...\ No newline at end of file
1 +{
2 + "type": "object",
3 + "title": "devices",
4 + "required": [
5 + "devices"
6 + ],
7 + "properties": {
8 + "devices": {
9 + "type": "object",
10 + "required": [
11 + "name",
12 + "value"
13 + ],
14 + "properties": {
15 + "name": {
16 + "type": "string"
17 + },
18 + "value": {
19 + "type": "object",
20 + "title": "metrics",
21 + "required": [
22 + "metrics"
23 + ],
24 + "properties": {
25 + "metrics": {
26 + "type": "array",
27 + "xml": {
28 + "name": "metrics",
29 + "wrapped": true
30 + },
31 + "items": {
32 + "type": "object",
33 + "title": "metrics",
34 + "required": [
35 + "inboundPacket",
36 + "outboundPacket",
37 + "flowModPacket",
38 + "flowRemovedPacket",
39 + "requestPacket",
40 + "replyPacket"
41 + ],
42 + "properties": {
43 + "inboundPacket": {
44 + "type": "object",
45 + "required": [
46 + "time",
47 + "latest",
48 + "average"
49 + ],
50 + "properties": {
51 + "time": {
52 + "type": "integer",
53 + "format": "int64"
54 + },
55 + "latest": {
56 + "type": "integer",
57 + "format": "int64"
58 + },
59 + "average": {
60 + "type": "integer",
61 + "format": "int64"
62 + }
63 + }
64 + },
65 + "outboundPacket": {
66 + "type": "object",
67 + "required": [
68 + "time",
69 + "latest",
70 + "average"
71 + ],
72 + "properties": {
73 + "time": {
74 + "type": "integer",
75 + "format": "int64"
76 + },
77 + "latest": {
78 + "type": "integer",
79 + "format": "int64"
80 + },
81 + "average": {
82 + "type": "integer",
83 + "format": "int64"
84 + }
85 + }
86 + },
87 + "flowModPacket": {
88 + "type": "object",
89 + "required": [
90 + "time",
91 + "latest",
92 + "average"
93 + ],
94 + "properties": {
95 + "time": {
96 + "type": "integer",
97 + "format": "int64"
98 + },
99 + "latest": {
100 + "type": "integer",
101 + "format": "int64"
102 + },
103 + "average": {
104 + "type": "integer",
105 + "format": "int64"
106 + }
107 + }
108 + },
109 + "flowRemovedPacket": {
110 + "type": "object",
111 + "required": [
112 + "time",
113 + "latest",
114 + "average"
115 + ],
116 + "properties": {
117 + "time": {
118 + "type": "integer",
119 + "format": "int64"
120 + },
121 + "latest": {
122 + "type": "integer",
123 + "format": "int64"
124 + },
125 + "average": {
126 + "type": "integer",
127 + "format": "int64"
128 + }
129 + }
130 + },
131 + "requestPacket": {
132 + "type": "object",
133 + "required": [
134 + "time",
135 + "latest",
136 + "average"
137 + ],
138 + "properties": {
139 + "time": {
140 + "type": "integer",
141 + "format": "int64"
142 + },
143 + "latest": {
144 + "type": "integer",
145 + "format": "int64"
146 + },
147 + "average": {
148 + "type": "integer",
149 + "format": "int64"
150 + }
151 + }
152 + },
153 + "replyPacket": {
154 + "type": "object",
155 + "required": [
156 + "time",
157 + "latest",
158 + "average"
159 + ],
160 + "properties": {
161 + "time": {
162 + "type": "integer",
163 + "format": "int64"
164 + },
165 + "latest": {
166 + "type": "integer",
167 + "format": "int64"
168 + },
169 + "average": {
170 + "type": "integer",
171 + "format": "int64"
172 + }
173 + }
174 + }
175 + }
176 + }
177 + }
178 + }
179 + }
180 + }
181 + }
182 + }
183 +}
...\ No newline at end of file ...\ No newline at end of file
1 +{
2 + "type": "object",
3 + "title": "metrics",
4 + "required": [
5 + "metrics"
6 + ],
7 + "properties": {
8 + "metrics": {
9 + "type": "array",
10 + "xml": {
11 + "name": "metrics",
12 + "wrapped": true
13 + },
14 + "items": {
15 + "type": "object",
16 + "title": "metrics",
17 + "required": [
18 + "cpuLoad",
19 + "totalCpuTime",
20 + "sysCpuTime",
21 + "userCpuTime",
22 + "cpuIdleTime"
23 + ],
24 + "properties": {
25 + "cpuLoad": {
26 + "type": "object",
27 + "required": [
28 + "time",
29 + "latest",
30 + "average"
31 + ],
32 + "properties": {
33 + "time": {
34 + "type": "integer",
35 + "format": "int64"
36 + },
37 + "latest": {
38 + "type": "integer",
39 + "format": "int64"
40 + },
41 + "average": {
42 + "type": "integer",
43 + "format": "int64"
44 + }
45 + }
46 + },
47 + "totalCpuTime": {
48 + "type": "object",
49 + "required": [
50 + "time",
51 + "latest",
52 + "average"
53 + ],
54 + "properties": {
55 + "time": {
56 + "type": "integer",
57 + "format": "int64"
58 + },
59 + "latest": {
60 + "type": "integer",
61 + "format": "int64"
62 + },
63 + "average": {
64 + "type": "integer",
65 + "format": "int64"
66 + }
67 + }
68 + },
69 + "sysCpuTime": {
70 + "type": "object",
71 + "required": [
72 + "time",
73 + "latest",
74 + "average"
75 + ],
76 + "properties": {
77 + "time": {
78 + "type": "integer",
79 + "format": "int64"
80 + },
81 + "latest": {
82 + "type": "integer",
83 + "format": "int64"
84 + },
85 + "average": {
86 + "type": "integer",
87 + "format": "int64"
88 + }
89 + }
90 + },
91 + "userCpuTime": {
92 + "type": "object",
93 + "required": [
94 + "time",
95 + "latest",
96 + "average"
97 + ],
98 + "properties": {
99 + "time": {
100 + "type": "integer",
101 + "format": "int64"
102 + },
103 + "latest": {
104 + "type": "integer",
105 + "format": "int64"
106 + },
107 + "average": {
108 + "type": "integer",
109 + "format": "int64"
110 + }
111 + }
112 + },
113 + "cpuIdleTime": {
114 + "type": "object",
115 + "required": [
116 + "time",
117 + "latest",
118 + "average"
119 + ],
120 + "properties": {
121 + "time": {
122 + "type": "integer",
123 + "format": "int64"
124 + },
125 + "latest": {
126 + "type": "integer",
127 + "format": "int64"
128 + },
129 + "average": {
130 + "type": "integer",
131 + "format": "int64"
132 + }
133 + }
134 + }
135 + }
136 + }
137 + }
138 + }
139 +}
...\ No newline at end of file ...\ No newline at end of file
1 +{
2 + "type": "object",
3 + "title": "disks",
4 + "required": [
5 + "disks"
6 + ],
7 + "properties": {
8 + "disks": {
9 + "type": "object",
10 + "required": [
11 + "name",
12 + "value"
13 + ],
14 + "properties": {
15 + "name": {
16 + "type": "string"
17 + },
18 + "value": {
19 + "type": "object",
20 + "title": "metrics",
21 + "required": [
22 + "metrics"
23 + ],
24 + "properties": {
25 + "metrics": {
26 + "type": "array",
27 + "xml": {
28 + "name": "metrics",
29 + "wrapped": true
30 + },
31 + "items": {
32 + "type": "object",
33 + "title": "metrics",
34 + "required": [
35 + "readBytes",
36 + "writeBytes"
37 + ],
38 + "properties": {
39 + "readBytes": {
40 + "type": "object",
41 + "required": [
42 + "time",
43 + "latest",
44 + "average"
45 + ],
46 + "properties": {
47 + "time": {
48 + "type": "integer",
49 + "format": "int64"
50 + },
51 + "latest": {
52 + "type": "integer",
53 + "format": "int64"
54 + },
55 + "average": {
56 + "type": "integer",
57 + "format": "int64"
58 + }
59 + }
60 + },
61 + "writeBytes": {
62 + "type": "object",
63 + "required": [
64 + "time",
65 + "latest",
66 + "average"
67 + ],
68 + "properties": {
69 + "time": {
70 + "type": "integer",
71 + "format": "int64"
72 + },
73 + "latest": {
74 + "type": "integer",
75 + "format": "int64"
76 + },
77 + "average": {
78 + "type": "integer",
79 + "format": "int64"
80 + }
81 + }
82 + }
83 + }
84 + }
85 + }
86 + }
87 + }
88 + }
89 + }
90 + }
91 +}
...\ No newline at end of file ...\ No newline at end of file
1 +{
2 + "type": "object",
3 + "title": "metrics",
4 + "required": [
5 + "metrics"
6 + ],
7 + "properties": {
8 + "metrics": {
9 + "type": "array",
10 + "xml": {
11 + "name": "metrics",
12 + "wrapped": true
13 + },
14 + "items": {
15 + "type": "object",
16 + "title": "metrics",
17 + "required": [
18 + "memoryUsedRatio",
19 + "memoryFreeRatio",
20 + "memoryUsed",
21 + "memoryFree"
22 + ],
23 + "properties": {
24 + "memoryUsedRatio": {
25 + "type": "object",
26 + "required": [
27 + "time",
28 + "latest",
29 + "average"
30 + ],
31 + "properties": {
32 + "time": {
33 + "type": "integer",
34 + "format": "int64"
35 + },
36 + "latest": {
37 + "type": "integer",
38 + "format": "int64"
39 + },
40 + "average": {
41 + "type": "integer",
42 + "format": "int64"
43 + }
44 + }
45 + },
46 + "memoryFreeRatio": {
47 + "type": "object",
48 + "required": [
49 + "time",
50 + "latest",
51 + "average"
52 + ],
53 + "properties": {
54 + "time": {
55 + "type": "integer",
56 + "format": "int64"
57 + },
58 + "latest": {
59 + "type": "integer",
60 + "format": "int64"
61 + },
62 + "average": {
63 + "type": "integer",
64 + "format": "int64"
65 + }
66 + }
67 + },
68 + "memoryUsed": {
69 + "type": "object",
70 + "required": [
71 + "time",
72 + "latest",
73 + "average"
74 + ],
75 + "properties": {
76 + "time": {
77 + "type": "integer",
78 + "format": "int64"
79 + },
80 + "latest": {
81 + "type": "integer",
82 + "format": "int64"
83 + },
84 + "average": {
85 + "type": "integer",
86 + "format": "int64"
87 + }
88 + }
89 + },
90 + "memoryFree": {
91 + "type": "object",
92 + "required": [
93 + "time",
94 + "latest",
95 + "average"
96 + ],
97 + "properties": {
98 + "time": {
99 + "type": "integer",
100 + "format": "int64"
101 + },
102 + "latest": {
103 + "type": "integer",
104 + "format": "int64"
105 + },
106 + "average": {
107 + "type": "integer",
108 + "format": "int64"
109 + }
110 + }
111 + }
112 + }
113 + }
114 + }
115 + }
116 +}
...\ No newline at end of file ...\ No newline at end of file
1 +{
2 + "type": "object",
3 + "title": "networks",
4 + "required": [
5 + "networks"
6 + ],
7 + "properties": {
8 + "networks": {
9 + "type": "object",
10 + "required": [
11 + "name",
12 + "value"
13 + ],
14 + "properties": {
15 + "name": {
16 + "type": "string"
17 + },
18 + "value": {
19 + "type": "object",
20 + "title": "metrics",
21 + "required": [
22 + "metrics"
23 + ],
24 + "properties": {
25 + "metrics": {
26 + "type": "array",
27 + "xml": {
28 + "name": "metrics",
29 + "wrapped": true
30 + },
31 + "items": {
32 + "type": "object",
33 + "title": "metrics",
34 + "required": [
35 + "incomingBytes",
36 + "outgoingBytes",
37 + "incomingPackets",
38 + "outgoingPackets"
39 + ],
40 + "properties": {
41 + "incomingBytes": {
42 + "type": "object",
43 + "required": [
44 + "time",
45 + "latest",
46 + "average"
47 + ],
48 + "properties": {
49 + "time": {
50 + "type": "integer",
51 + "format": "int64"
52 + },
53 + "latest": {
54 + "type": "integer",
55 + "format": "int64"
56 + },
57 + "average": {
58 + "type": "integer",
59 + "format": "int64"
60 + }
61 + }
62 + },
63 + "outgoingBytes": {
64 + "type": "object",
65 + "required": [
66 + "time",
67 + "latest",
68 + "average"
69 + ],
70 + "properties": {
71 + "time": {
72 + "type": "integer",
73 + "format": "int64"
74 + },
75 + "latest": {
76 + "type": "integer",
77 + "format": "int64"
78 + },
79 + "average": {
80 + "type": "integer",
81 + "format": "int64"
82 + }
83 + }
84 + },
85 + "incomingPackets": {
86 + "type": "object",
87 + "required": [
88 + "time",
89 + "latest",
90 + "average"
91 + ],
92 + "properties": {
93 + "time": {
94 + "type": "integer",
95 + "format": "int64"
96 + },
97 + "latest": {
98 + "type": "integer",
99 + "format": "int64"
100 + },
101 + "average": {
102 + "type": "integer",
103 + "format": "int64"
104 + }
105 + }
106 + },
107 + "outgoingPackets": {
108 + "type": "object",
109 + "required": [
110 + "time",
111 + "latest",
112 + "average"
113 + ],
114 + "properties": {
115 + "time": {
116 + "type": "integer",
117 + "format": "int64"
118 + },
119 + "latest": {
120 + "type": "integer",
121 + "format": "int64"
122 + },
123 + "average": {
124 + "type": "integer",
125 + "format": "int64"
126 + }
127 + }
128 + }
129 + }
130 + }
131 + }
132 + }
133 + }
134 + }
135 + }
136 + }
137 +}
...\ No newline at end of file ...\ No newline at end of file