Add Swagger comments and dependencies to appsm with REST APIs
ONOS-2704 and ONOS-2705
Change-Id: I77655af94f8b5aba647a94b3b786a6de8a285d7c
diff --git a/apps/virtualbng/src/main/java/org/onosproject/virtualbng/VbngResource.java b/apps/virtualbng/src/main/java/org/onosproject/virtualbng/VbngResource.java
index 36f8832..c6a9c9b 100644
--- a/apps/virtualbng/src/main/java/org/onosproject/virtualbng/VbngResource.java
+++ b/apps/virtualbng/src/main/java/org/onosproject/virtualbng/VbngResource.java
@@ -37,13 +37,21 @@
import org.slf4j.Logger;
/**
- * This class provides REST services to virtual BNG.
+ * REST services to interact with the virtual BNG.
*/
@Path("privateip")
public class VbngResource extends AbstractWebResource {
private final Logger log = getLogger(getClass());
+ /**
+ * Create a new virtual BNG connection.
+ *
+ * @param privateIp IP Address for the BNG private network
+ * @param mac MAC address for the host
+ * @param hostName name of the host
+ * @return public IP address for the new connection
+ */
@POST
@Path("{privateip}/{mac}/{hostname}")
public String privateIpAddNotification(@PathParam("privateip")
@@ -77,6 +85,12 @@
}
}
+ /**
+ * Delete a virtual BNG connection.
+ *
+ * @param privateIp IP Address for the BNG private network
+ * @return public IP address for the new connection
+ */
@DELETE
@Path("{privateip}")
public String privateIpDeleteNotification(@PathParam("privateip")
@@ -101,6 +115,11 @@
}
}
+ /**
+ * Query virtual BNG map.
+ *
+ * @return IP Address map
+ */
@GET
@Path("map")
@Produces(MediaType.APPLICATION_JSON)
@@ -119,4 +138,4 @@
return ok(result.toString()).build();
}
-}
\ No newline at end of file
+}