홍길동 / onos

Go to a project
Toggle navigation Toggle navigation pinning
Andrea Campanella
Committed by Gerrit Code Review
10c4adc2 1 parent 4380f549

ONOS-2706 Changing rsModel annotation to onos.rsModel 

Change-Id: I1c22a7e1e147f13b960c3a6095408d68173ca966
Inline Side-by-side
Showing 15 changed files with 42 additions and 42 deletions
......@@ -51,7 +51,7 @@ public class DhcpWebResource extends AbstractWebResource {
* Shows lease, renewal and rebinding times in seconds.
*
* @return 200 OK
* @rsModel DhcpConfigGet
* @onos.rsModel DhcpConfigGet
*/
@GET
@Path("config")
......@@ -68,7 +68,7 @@ public class DhcpWebResource extends AbstractWebResource {
* Get all MAC/IP mappings.
* Shows all MAC/IP mappings held by the DHCP server.
*
* @rsModel DhcpConfigGetMappings
* @onos.rsModel DhcpConfigGetMappings
* @return 200 OK
*/
@GET
......@@ -90,7 +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
* @onos.rsModel DhcpConfigGetAvailable
* @return 200 OK
*/
@GET
......@@ -108,7 +108,7 @@ public class DhcpWebResource extends AbstractWebResource {
* Post a new static MAC/IP binding.
* Registers a static binding to the DHCP server, and displays the current set of bindings.
*
* @rsModel DhcpConfigPut
* @onos.rsModel DhcpConfigPut
* @param stream JSON stream
* @return 200 OK
*/
......
......@@ -71,7 +71,7 @@
</groups>
<tags>
<tag>
<name>rsModel</name>
<name>onos.rsModel</name>
<placement>m</placement>
<head>Json model for REST api:</head>
</tag>
......
......@@ -127,7 +127,7 @@
</groups>
<tags>
<tag>
<name>rsModel</name>
<name>onos.rsModel</name>
<placement>m</placement>
<head>Json model for REST api:</head>
</tag>
......
......@@ -556,7 +556,7 @@
<configuration>
<tags>
<tag>
<name>rsModel</name>
<name>onos.rsModel</name>
<placement>m</placement>
<head>Json model for REST api:</head>
</tag>
......
......@@ -243,7 +243,7 @@ public class OnosSwaggerMojo extends AbstractMojo {
String resourcePath, ArrayNode tagArray, ObjectNode definitions) {
String fullPath = resourcePath, consumes = "", produces = "",
comment = javaMethod.getComment();
DocletTag tag = javaMethod.getTagByName("rsModel");
DocletTag tag = javaMethod.getTagByName("onos.rsModel");
for (JavaAnnotation annotation : javaMethod.getAnnotations()) {
String name = annotation.getType().getName();
if (name.equals(PATH)) {
......
......@@ -44,7 +44,7 @@ public class ApplicationsWebResource extends AbstractWebResource {
* Get all installed applications.
* Returns array of all installed applications.
*
* @rsModel Applications
* @onos.rsModel Applications
* @return 200 OK
*/
@GET
......@@ -57,7 +57,7 @@ public class ApplicationsWebResource extends AbstractWebResource {
/**
* Get application details.
* Returns details of the specified application.
* @rsModel Application
* @onos.rsModel Application
* @param name application name
* @return 200 OK; 404; 401
*/
......
......@@ -49,7 +49,7 @@ public class ClusterWebResource extends AbstractWebResource {
* Returns array of all cluster nodes.
*
* @return 200 OK
* @rsModel Cluster
* @onos.rsModel Cluster
*/
@GET
public Response getClusterNodes() {
......@@ -63,7 +63,7 @@ public class ClusterWebResource extends AbstractWebResource {
*
* @param id cluster node identifier
* @return 200 OK
* @rsModel ClusterNode
* @onos.rsModel ClusterNode
*/
@GET
@Path("{id}")
......@@ -80,7 +80,7 @@ public class ClusterWebResource extends AbstractWebResource {
* @param config cluster definition
* @return 200 OK
* @throws IOException to signify bad request
* @rsModel ClusterPost
* @onos.rsModel ClusterPost
*/
@POST
@Path("configuration")
......
......@@ -46,7 +46,7 @@ public class DevicesWebResource extends AbstractWebResource {
* Returns array of all discovered infrastructure devices.
*
* @return 200 OK
* @rsModel DevicesGet
* @onos.rsModel DevicesGet
*/
@GET
public Response getDevices() {
......@@ -60,7 +60,7 @@ public class DevicesWebResource extends AbstractWebResource {
*
* @param id device identifier
* @return 200 OK
* @rsModel DeviceGet
* @onos.rsModel DeviceGet
*/
@GET
@Path("{id}")
......@@ -91,7 +91,7 @@ public class DevicesWebResource extends AbstractWebResource {
* Get ports of infrastructure device.
* Returns details of the specified infrastructure device.
*
* @rsModel DeviceGetPorts
* @onos.rsModel DeviceGetPorts
* @param id device identifier
* @return 200 OK
*/
......
......@@ -58,7 +58,7 @@ public class FlowsWebResource extends AbstractWebResource {
/**
* Get all flow entries. Returns array of all flow rules in the system.
* @rsModel Flows
* @onos.rsModel Flows
* @return array of all the intents in the system
*/
@GET
......@@ -80,7 +80,7 @@ public class FlowsWebResource extends AbstractWebResource {
/**
* Get flow entries of a device. Returns array of all flow rules for the
* specified device.
* @rsModel Flows
* @onos.rsModel Flows
* @param deviceId device identifier
* @return flow data as an array
*/
......@@ -103,7 +103,7 @@ public class FlowsWebResource extends AbstractWebResource {
/**
* Get flow rule. Returns the flow entry specified by the device id and
* flow rule id.
* @rsModel Flows
* @onos.rsModel Flows
* @param deviceId device identifier
* @param flowId flow rule identifier
* @return flow data as an array
......@@ -130,7 +130,7 @@ public class FlowsWebResource extends AbstractWebResource {
/**
* Create new flow rule. Creates and installs a new flow rule for the
* specified device.
* @rsModel FlowsPost
* @onos.rsModel FlowsPost
* @param deviceId device identifier
* @param stream flow rule JSON
* @return status of the request - CREATED if the JSON is correct,
......
......@@ -73,7 +73,7 @@ public class HostsWebResource extends AbstractWebResource {
* Returns array of all known end-station hosts.
*
* @return 200 OK
* @rsModel Hosts
* @onos.rsModel Hosts
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -89,7 +89,7 @@ public class HostsWebResource extends AbstractWebResource {
*
* @param id host identifier
* @return 200 OK
* @rsModel Host
* @onos.rsModel Host
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -108,7 +108,7 @@ public class HostsWebResource extends AbstractWebResource {
* @param mac host MAC address
* @param vlan host VLAN identifier
* @return 200 OK
* @rsModel Host
* @onos.rsModel Host
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -128,7 +128,7 @@ public class HostsWebResource extends AbstractWebResource {
* @param stream input JSON
* @return status of the request - CREATED if the JSON is correct,
* BAD_REQUEST if the JSON is invalid
* @rsModel HostPut
* @onos.rsModel HostPut
*/
@POST
@Consumes(MediaType.APPLICATION_JSON)
......
......@@ -70,7 +70,7 @@ public class IntentsWebResource extends AbstractWebResource {
/**
* Get all intents.
* Returns array containing all the intents in the system.
* @rsModel Intents
* @onos.rsModel Intents
* @return array of all the intents in the system
*/
@GET
......@@ -84,7 +84,7 @@ public class IntentsWebResource extends AbstractWebResource {
/**
* Get intent by application and key.
* Returns details of the specified intent.
* @rsModel Intents
* @onos.rsModel Intents
* @param appId application identifier
* @param key intent key
* @return intent data
......@@ -136,7 +136,7 @@ public class IntentsWebResource extends AbstractWebResource {
/**
* Submit a new intent.
* Creates and submits intent from the JSON request.
* @rsModel IntentHost
* @onos.rsModel IntentHost
* @param stream input JSON
* @return status of the request - CREATED if the JSON is correct,
* BAD_REQUEST if the JSON is invalid
......
......@@ -44,7 +44,7 @@ public class LinksWebResource extends AbstractWebResource {
/**
* Get infrastructure links.
* Returns array of all links, or links for the specified device or port.
* @rsModel LinksGet
* @onos.rsModel LinksGet
* @param deviceId (optional) device identifier
* @param port (optional) port number
* @param direction (optional) direction qualifier
......
......@@ -60,7 +60,7 @@ public class PathsWebResource extends AbstractWebResource {
/**
* Get all shortest paths between any two hosts or devices.
* Returns array of all shortest paths between any two elements.
* @rsModel Paths
* @onos.rsModel Paths
* @param src source identifier
* @param dst destination identifier
* @return path data
......@@ -79,7 +79,7 @@ public class PathsWebResource extends AbstractWebResource {
/**
* Get all shortest disjoint paths between any two hosts or devices.
* Returns array of all shortest disjoint paths between any two elements.
* @rsModel Paths
* @onos.rsModel Paths
* @param src source identifier
* @param dst destination identifier
* @return path data
......
......@@ -60,7 +60,7 @@ public class StatisticsWebResource extends AbstractWebResource {
/**
* Get load statistics for all links or for a specific link.
* @rsModel StatisticsFlowsLink
* @onos.rsModel StatisticsFlowsLink
* @param deviceId (optional) device ID for a specific link
* @param port (optional) port number for a specified link
* @return JSON encoded array lof Load objects
......@@ -102,7 +102,7 @@ public class StatisticsWebResource extends AbstractWebResource {
/**
* Get table statistics for all tables of all devices.
* @rsModel StatisticsFlowsTables
* @onos.rsModel StatisticsFlowsTables
* @return JSON encoded array of table statistics
*/
@GET
......@@ -131,7 +131,7 @@ public class StatisticsWebResource extends AbstractWebResource {
/**
* Get table statistics for all tables of a specified device.
* @rsModel StatisticsFlowsTables
* @onos.rsModel StatisticsFlowsTables
* @param deviceId device ID
* @return JSON encoded array of table statistics
*/
......@@ -157,7 +157,7 @@ public class StatisticsWebResource extends AbstractWebResource {
/**
* Get port statistics of all devices.
* @rsModel StatisticsPorts
* @onos.rsModel StatisticsPorts
* @return JSON encoded array of port statistics
*/
@GET
......@@ -186,7 +186,7 @@ public class StatisticsWebResource extends AbstractWebResource {
/**
* Get port statistics of a specified devices.
* @rsModel StatisticsPorts
* @onos.rsModel StatisticsPorts
* @param deviceId device ID
* @return JSON encoded array of port statistics
*/
......
......@@ -50,7 +50,7 @@ public class TopologyWebResource extends AbstractWebResource {
* Get overview of current topology.
*
* @return topology overview
* @rsModel Topology
* @onos.rsModel Topology
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -64,7 +64,7 @@ public class TopologyWebResource extends AbstractWebResource {
* Get overview of topology SCCs.
*
* @return topology clusters overview
* @rsModel TopologyClusters
* @onos.rsModel TopologyClusters
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -82,7 +82,7 @@ public class TopologyWebResource extends AbstractWebResource {
*
* @param clusterId id of the cluster to query
* @return topology cluster details
* @rsModel TopologyCluster
* @onos.rsModel TopologyCluster
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -106,7 +106,7 @@ public class TopologyWebResource extends AbstractWebResource {
*
* @param clusterId id of the cluster to query
* @return topology cluster devices
* @rsModel TopologyClustersDevices
* @onos.rsModel TopologyClustersDevices
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -130,7 +130,7 @@ public class TopologyWebResource extends AbstractWebResource {
*
* @param clusterId id of the cluster to query
* @return topology cluster links
* @rsModel LinksGet
* @onos.rsModel LinksGet
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -180,7 +180,7 @@ public class TopologyWebResource extends AbstractWebResource {
* @param connectPointString deviceid:portnumber
* @return JSON representation of true if the connect point is broadcast,
* false otherwise
* @rsModel TopologyBroadcast
* @onos.rsModel TopologyBroadcast
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......@@ -205,7 +205,7 @@ public class TopologyWebResource extends AbstractWebResource {
* @param connectPointString deviceid:portnumber
* @return JSON representation of true if the connect point is broadcast,
* false otherwise
* @rsModel TopologyInfrastructure
* @onos.rsModel TopologyInfrastructure
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
......