ONOS-3607 Add Criteria model for Flows REST Api with field description.
Change Model parsing in Swagger mojo for whitspaces stripping.
Also, readding onos-maven-plugin to root pom build temporarily.
Change-Id: I8995c74d762a3e59acebe15cc600a0f1bfa41411
diff --git a/web/api/src/main/resources/definitions/Flows.json b/web/api/src/main/resources/definitions/Flows.json
index c803fdb..e3fa3f0 100644
--- a/web/api/src/main/resources/definitions/Flows.json
+++ b/web/api/src/main/resources/definitions/Flows.json
@@ -155,19 +155,214 @@
"items": {
"type": "object",
"title": "criteria",
- "required": [
- "type",
- "ethType"
- ],
"properties": {
"type": {
"type": "string",
+ "description":"Ethernet field name",
"example": "ETH_TYPE"
},
"ethType": {
+ "type": "int64",
+ "format": "int64",
+ "example": "0x88cc",
+ "description":"Ethernet frame type"
+ },
+ "mac": {
+ "type": "string",
+ "example": "00:00:11:00:00:01"
+ },
+ "port": {
+ "type": "int64",
+ "format": "int64",
+ "example": 1,
+ "description":"Match port"
+ },
+ "metadata": {
+ "type": "Hex16",
+ "format": "Hex16",
+ "example": "0xabcdL",
+ "description":"Metadata passed between tables"
+ },
+ "vlanId": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": "0x1000"
+ },
+ "priority": {
+ "type": "int64",
+ "format": "int64",
+ "example": 1,
+ "description":"VLAN priority."
+ },
+ "ipDscp": {
+ "type": "byte",
+ "format": "byte",
+ "description":"IP DSCP (6 bits in ToS field)"
+ },
+ "ipEcn": {
+ "type": "byte",
+ "format": "byte",
+ "description":"IP ECN (2 bits in ToS field)."
+ },
+ "protocol": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"IP protocol"
+ },
+ "ip": {
+ "type": "string",
+ "example": "10.1.1.0/24",
+ "description":"IP source address"
+ },
+ "tcpPort": {
+ "type": "integer",
+ "format": "uint16",
+ "example": 1,
+ "description":"TCP source address"
+ },
+ "udpPort": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"UDP source address"
+ },
+ "sctpPort": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"SCTP source address"
+ },
+ "icmpType": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"Internet Control Message Protocol for IPV4 code (RFC0792)"
+ },
+ "icmpCode": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"Internet Control Message Protocol for IPV4 code (RFC0792)"
+ },
+ "flowLabel": {
+ "type": "Hex16",
+ "format": "Hex16",
+ "example": "0xffffe",
+ "description":"IPv6 Flow Label (RFC 6437)"
+ },
+ "icmpv6Type": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"Internet Control Message Protocol for IPV6 type (RFC2463)"
+ },
+ "icmpv6Code": {
+ "type": "uint16",
+ "format": "uint16",
+ "example": 1,
+ "description":"Internet Control Message Protocol for IPV6 code (RFC2463)"
+ },
+ "targetAddress": {
+ "type": "String",
+ "example": "10.1.1.0/24",
+ "description":"IPv6 Neighbor discovery target address"
+ },
+ "label": {
+ "type": "int32",
+ "format": "int32",
+ "example": 1,
+ "description":"MPLS label"
+ },
+ "exthdrFlags": {
+ "type": "int64",
+ "format": "int64",
+ "example": 1,
+ "description":"IPv6 extension header pseudo-field"
+ },
+ "lambda": {
+ "type": "int64",
+ "format": "int64",
+ "example": 1,
+ "description":"wavelength abstraction"
+ },
+ "gridType": {
+ "type": "String",
+ "example": "DWDM",
+ "description":"Type of wavelength grid"
+ },
+ "channelSpacing": {
+ "type": "int64",
+ "format": "int64",
+ "example": 100,
+ "description":"Optical channel spacing"
+ },
+ "spacingMultiplier": {
"type": "integer",
"format": "int64",
- "example": "0x88cc"
+ "example": 4,
+ "description":"Optical channel spacing multiplier"
+ },
+ "slotGranularity": {
+ "type": "int64",
+ "format": "int64",
+ "example": 8
+ },
+ "ochSignalId": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1,
+ "description":"Optical channel signal ID"
+ },
+ "tunnelId": {
+ "type": "int64",
+ "format": "int64",
+ "example": 5,
+ "description":"Tunnel ID"
+ },
+ "ochSignalType": {
+ "type": "int64",
+ "format": "int64",
+ "example": 1,
+ "description":"Optical channel signal type"
+ },
+ "oduSignalId": {
+ "type": "int64",
+ "format": "int64",
+ "example": 1,
+ "description":"ODU (Optical channel Data Unit) signal ID."
+ },
+ "tributaryPortNumber": {
+ "type": "int64",
+ "format": "int64",
+ "example": 11,
+ "description":"OPU (Optical channel Payload Unit) port number."
+ },
+ "tributarySlotLen": {
+ "type": "int64",
+ "format": "int64",
+ "example": 80,
+ "description":"OPU (Optical channel Payload Unit) slot length."
+ },
+ "tributarySlotBitmap": {
+ "type": "array",
+ "title": "tributarySlotBitmap",
+ "description":"OPU (Optical channel Payload Unit) slot bitmap.",
+ "required": [
+ "byte",
+ "port"
+ ],
+ "items": {
+ "type": "byte",
+ "title": "byte",
+ "example": 1
+ }
+ },
+ "oduSignalType": {
+ "type": "int64",
+ "format": "int64",
+ "example": 4,
+ "description":"ODU (Optical channel Data Unit) signal type."
}
}
}