mirrors/onos
1
0
Fork 0
mirror of https://github.com/opennetworkinglab/onos.git synced 2025-12-08 19:02:00 +01:00
Code Issues Projects Releases Wiki Activity

[ONOS-3394] JsonModels for Swagger UI

Browse Source 
Change-Id: I57503b28df517642ab15e2b18f66ad63c15b7b8a
This commit is contained in:
andrea 2015-11-18 10:25:28 -08:00 committed by Gerrit Code Review
parent 696e1e8952
commit 5056b51aeb
9 changed files with 425 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebResource.java
View File

@ -68,6 +68,7 @@ public class DhcpWebResource extends AbstractWebResource {
* Get all MAC/IP mappings.
* Shows all MAC/IP mappings held by the DHCP server.
*
* @rsModel DhcpConfigGetMappings
* @return 200 OK
*/
@GET
@ -89,6 +90,7 @@ public class DhcpWebResource extends AbstractWebResource {
* Get all available IPs.
* Shows all the IPs in the free pool of the DHCP Server.
*
* @rsModel DhcpConfigGetAvailable
* @return 200 OK
*/
@GET

16
apps/dhcp/app/src/main/resources/definitions/DhcpConfigGetAvailable.json Normal file
View File

@ -0,0 +1,16 @@
{
"type": "object",
"required": [
"availableIp"
],
"properties": {
"availableIp": {
"type": "array",
"items": {
"type": "string"
},
"example": "[127.0.0.1]"
}
}
}

16
apps/dhcp/app/src/main/resources/definitions/DhcpConfigGetMappings.json Normal file
View File

@ -0,0 +1,16 @@
{
"type": "object",
"required": [
"mappings"
],
"properties": {
"mappings": {
"type": "array",
"items": {
"type": "string"
},
"example": "[]"
}
}
}

3
web/api/src/main/java/org/onosproject/rest/resources/DevicesWebResource.java
View File

@ -46,6 +46,7 @@ public class DevicesWebResource extends AbstractWebResource {
* Returns array of all discovered infrastructure devices.
*
* @return 200 OK
* @rsModel DevicesGet
*/
@GET
public Response getDevices() {
@ -59,6 +60,7 @@ public class DevicesWebResource extends AbstractWebResource {
*
* @param id device identifier
* @return 200 OK
* @rsModel DeviceGet
*/
@GET
@Path("{id}")
@ -89,6 +91,7 @@ public class DevicesWebResource extends AbstractWebResource {
* Get ports of infrastructure device.
* Returns details of the specified infrastructure device.
*
* @rsModel DeviceGetPorts
* @param id device identifier
* @return 200 OK
*/

3
web/api/src/main/java/org/onosproject/rest/resources/NetworkConfigWebResource.java
View File

@ -40,7 +40,7 @@ public class NetworkConfigWebResource extends AbstractWebResource {
/**
* Get entire network configuration base.
*
* @rsModel NetCfgGet
* @return network configuration JSON
*/
@GET
@ -131,6 +131,7 @@ public class NetworkConfigWebResource extends AbstractWebResource {
/**
* Upload bulk network configuration.
*
* @rsModel NetCfgGet
* @param request network configuration JSON rooted at the top node
* @return empty response
* @throws IOException if unable to parse the request

77
web/api/src/main/resources/definitions/DeviceGet.json Normal file
View File

@ -0,0 +1,77 @@
{
"type": "object",
"title": "device",
"required": [
"id",
"type",
"available",
"role",
"mfr",
"hw",
"sw",
"serial",
"chassisId",
"annotations"
],
"properties": {
"id": {
"type": "string",
"example": "of:0000000000000001"
},
"type": {
"type": "string",
"example": "SWITCH"
},
"available": {
"type": "boolean",
"example": true
},
"role": {
"type": "string",
"example": "of:0000000000000001"
},
"mfr": {
"type": "string",
"example": "Nicira, Inc."
},
"hw": {
"type": "string",
"example": "Open vSwitch"
},
"sw": {
"type": "string",
"example": "2.3.1"
},
"serial": {
"type": "string",
"example": "123"
},
"chassisId": {
"type": "string",
"example": "1"
},
"annotations": {
"type": "object",
"title": "annotations",
"required": [
"managementAddress",
"protocol",
"channelId"
],
"properties": {
"managementAddress": {
"type": "string",
"example": "123"
},
"protocol": {
"type": "string",
"example": "OF_13"
},
"channelId": {
"type": "string",
"example": "10.128.12.4:34689"
}
}
}
}
}

132
web/api/src/main/resources/definitions/DeviceGetPorts.json Normal file
View File

@ -0,0 +1,132 @@
{
"type": "object",
"title": "device",
"required": [
"id",
"type",
"available",
"role",
"mfr",
"hw",
"sw",
"serial",
"chassisId",
"annotations"
],
"properties": {
"id": {
"type": "string",
"example": "of:0000000000000001"
},
"type": {
"type": "string",
"example": "SWITCH"
},
"available": {
"type": "boolean",
"example": true
},
"role": {
"type": "string",
"example": "of:0000000000000001"
},
"mfr": {
"type": "string",
"example": "Nicira, Inc."
},
"hw": {
"type": "string",
"example": "Open vSwitch"
},
"sw": {
"type": "string",
"example": "2.3.1"
},
"serial": {
"type": "string",
"example": "123"
},
"chassisId": {
"type": "string",
"example": "1"
},
"annotations": {
"type": "object",
"title": "annotations",
"required": [
"managementAddress",
"protocol",
"channelId"
],
"properties": {
"managementAddress": {
"type": "string",
"example": "123"
},
"protocol": {
"type": "string",
"example": "OF_13"
},
"channelId": {
"type": "string",
"example": "10.128.12.4:34689"
}
}
},
"ports": {
"type": "array",
"xml": {
"name": "port",
"wrapped": true
},
"items": {
"type": "object",
"title": "port",
"required": [
"element",
"port",
"isEnabled",
"type",
"portSpeed",
"annotations"
],
"properties": {
"element": {
"type": "string",
"example": "of:0000000000000001"
},
"port": {
"type": "string",
"example": "2"
},
"isEnabled": {
"type": "boolean",
"example": true
},
"type": {
"type": "string",
"example": "copper"
},
"portSpeed": {
"type": "integer",
"format": "int64",
"example": 0
},
"annotations": {
"type": "object",
"title": "annotations",
"required": [
"portName"
],
"properties": {
"portName": {
"type": "string",
"example": "s1"
}
}
}
}
}
}
}
}

84
web/api/src/main/resources/definitions/DevicesGet.json Normal file
View File

@ -0,0 +1,84 @@
{
"type": "array",
"xml": {
"name": "device",
"wrapped": true
},
"items": {
"type": "object",
"title": "device",
"required": [
"id",
"type",
"available",
"role",
"mfr",
"hw",
"sw",
"serial",
"chassisId",
"annotations"
],
"properties": {
"id": {
"type": "string",
"example": "of:0000000000000001"
},
"type": {
"type": "string",
"example": "SWITCH"
},
"available": {
"type": "boolean",
"example": true
},
"role": {
"type": "string",
"example": "of:0000000000000001"
},
"mfr": {
"type": "string",
"example": "Nicira, Inc."
},
"hw": {
"type": "string",
"example": "Open vSwitch"
},
"sw": {
"type": "string",
"example": "2.3.1"
},
"serial": {
"type": "string",
"example": "123"
},
"chassisId": {
"type": "string",
"example": "1"
},
"annotations": {
"type": "object",
"title": "annotations",
"required": [
"managementAddress",
"protocol",
"channelId"
],
"properties": {
"managementAddress": {
"type": "string",
"example": "123"
},
"protocol": {
"type": "string",
"example": "OF_13"
},
"channelId": {
"type": "string",
"example": "10.128.12.4:34689"
}
}
}
}
}
}

93
web/api/src/main/resources/definitions/NetCfgGet.json Normal file
View File

@ -0,0 +1,93 @@
{
"type": "object",
"required": [
"apps",
"links",
"domains",
"hosts",
"ports",
"devices"
],
"properties": {
"apps": {
"type": "object"
},
"links": {
"title": "links",
"type": "object",
"properties": {
"deviceId/port-deviceId/port": {
"title": "basic",
"type": "object",
"required": [
"basic"
],
"properties": {
"basic": {
"title": "basic",
"type": "object",
"properties": {
"allowed": {
"type": "boolean",
"example": true
}
}
}
}
}
}
},
"domains": {
"type": "object"
},
"hosts": {
"type": "object"
},
"ports": {
"type": "object"
},
"devices": {
"title": "Devices",
"type": "object",
"required": [
"deviceId"
],
"properties": {
"deviceId": {
"title": "basic",
"type": "object",
"required": [
"basic"
],
"properties": {
"basic": {
"title": "basicDevice",
"type": "object",
"required": [
"allowed"
],
"properties": {
"allowed": {
"type": "boolean",
"example": true
},
"name": {
"type": "string",
"example": "DeviceName"
},
"owner": {
"type": "string",
"example": "OwnerName"
},
"latitude": {
"type": "string",
"example": "25"
}
}
}
}
}
}
}
}
}