홍길동 / 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 {
* Returns control message metrics of all devices.
*
* @return array of all control message metrics
* @onos.rsModel ControlMessageMetrics
*/
@GET
@Path("messages")
......@@ -86,6 +87,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
*
* @param deviceId device identification
* @return control message metrics of a given device
* @onos.rsModel ControlMessageMetric
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -102,6 +104,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
* Returns cpu metrics.
*
* @return cpu metrics
* @onos.rsModel CpuMetrics
*/
@GET
@Path("cpu_metrics")
......@@ -116,6 +119,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
* Returns memory metrics.
*
* @return memory metrics
* @onos.rsModel MemoryMetrics
*/
@GET
@Path("memory_metrics")
......@@ -130,6 +134,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
* Returns disk metrics of all resources.
*
* @return disk metrics of all resources
* @onos.rsModel DiskMetrics
*/
@GET
@Path("disk_metrics")
......@@ -155,6 +160,7 @@ public class ControlMetricsWebResource extends AbstractWebResource {
* Returns network metrics of all resources.
*
* @return network metrics of all resources
* @onos.rsModel NetworkMetrics
*/
@GET
@Path("network_metrics")
......
{
"type": "object",
"title": "metrics",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"xml": {
"name": "metrics",
"wrapped": true
},
"items": {
"type": "object",
"title": "metrics",
"required": [
"inboundPacket",
"outboundPacket",
"flowModPacket",
"flowRemovedPacket",
"requestPacket",
"replyPacket"
],
"properties": {
"inboundPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"outboundPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"flowModPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"flowRemovedPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"requestPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"replyPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
\ No newline at end of file
{
"type": "object",
"title": "devices",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "object",
"title": "metrics",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"xml": {
"name": "metrics",
"wrapped": true
},
"items": {
"type": "object",
"title": "metrics",
"required": [
"inboundPacket",
"outboundPacket",
"flowModPacket",
"flowRemovedPacket",
"requestPacket",
"replyPacket"
],
"properties": {
"inboundPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"outboundPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"flowModPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"flowRemovedPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"requestPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"replyPacket": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
}
}
}
}
\ No newline at end of file
{
"type": "object",
"title": "metrics",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"xml": {
"name": "metrics",
"wrapped": true
},
"items": {
"type": "object",
"title": "metrics",
"required": [
"cpuLoad",
"totalCpuTime",
"sysCpuTime",
"userCpuTime",
"cpuIdleTime"
],
"properties": {
"cpuLoad": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"totalCpuTime": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"sysCpuTime": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"userCpuTime": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"cpuIdleTime": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
\ No newline at end of file
{
"type": "object",
"title": "disks",
"required": [
"disks"
],
"properties": {
"disks": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "object",
"title": "metrics",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"xml": {
"name": "metrics",
"wrapped": true
},
"items": {
"type": "object",
"title": "metrics",
"required": [
"readBytes",
"writeBytes"
],
"properties": {
"readBytes": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"writeBytes": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
}
}
}
}
\ No newline at end of file
{
"type": "object",
"title": "metrics",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"xml": {
"name": "metrics",
"wrapped": true
},
"items": {
"type": "object",
"title": "metrics",
"required": [
"memoryUsedRatio",
"memoryFreeRatio",
"memoryUsed",
"memoryFree"
],
"properties": {
"memoryUsedRatio": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"memoryFreeRatio": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"memoryUsed": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"memoryFree": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
\ No newline at end of file
{
"type": "object",
"title": "networks",
"required": [
"networks"
],
"properties": {
"networks": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "object",
"title": "metrics",
"required": [
"metrics"
],
"properties": {
"metrics": {
"type": "array",
"xml": {
"name": "metrics",
"wrapped": true
},
"items": {
"type": "object",
"title": "metrics",
"required": [
"incomingBytes",
"outgoingBytes",
"incomingPackets",
"outgoingPackets"
],
"properties": {
"incomingBytes": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"outgoingBytes": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"incomingPackets": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
},
"outgoingPackets": {
"type": "object",
"required": [
"time",
"latest",
"average"
],
"properties": {
"time": {
"type": "integer",
"format": "int64"
},
"latest": {
"type": "integer",
"format": "int64"
},
"average": {
"type": "integer",
"format": "int64"
}
}
}
}
}
}
}
}
}
}
}
}
\ No newline at end of file