ONOS-2486 Adding swagger-based REST API documentation.
Change-Id: I237d973d73549ad30ddc638c1c201f024d344c70
diff --git a/apps/acl/pom.xml b/apps/acl/pom.xml
index 698771e..20f784f 100644
--- a/apps/acl/pom.xml
+++ b/apps/acl/pom.xml
@@ -39,7 +39,13 @@
<onos.version>1.3.0-SNAPSHOT</onos.version>
<onos.app.name>org.onosproject.acl</onos.app.name>
<onos.app.origin>DLUT</onos.app.origin>
- <web.context>/onos/v1/acl</web.context>
+ <web.context>/onos/acl</web.context>
+ <api.version>1.0.0</api.version>
+ <api.title>ONOS ACL Application REST API</api.title>
+ <api.description>
+ APIs for interacting with the ACL application.
+ </api.description>
+ <api.package>org.onos.acl.impl</api.package>
</properties>
<dependencies>
@@ -108,6 +114,10 @@
<configuration>
<instructions>
<_wab>src/main/webapp/</_wab>
+ <Include-Resource>
+ WEB-INF/classes/apidoc/swagger.json=target/swagger.json,
+ {maven-resources}
+ </Include-Resource>
<Bundle-SymbolicName>
${project.groupId}.${project.artifactId}
</Bundle-SymbolicName>
diff --git a/apps/acl/src/main/java/org/onos/acl/AclWebResource.java b/apps/acl/src/main/java/org/onos/acl/AclWebResource.java
index 2ef8041..d7e2e57 100644
--- a/apps/acl/src/main/java/org/onos/acl/AclWebResource.java
+++ b/apps/acl/src/main/java/org/onos/acl/AclWebResource.java
@@ -40,8 +40,9 @@
import java.io.InputStream;
import java.util.List;
+// FIXME: This does now follow REST-full principles and should be refactored.
/**
- * REST resource for interacting with ACL application.
+ * Manage ACL rules.
*/
@Path("")
public class AclWebResource extends AbstractWebResource {
diff --git a/apps/cordfabric/pom.xml b/apps/cordfabric/pom.xml
index bfdd199..f538855 100644
--- a/apps/cordfabric/pom.xml
+++ b/apps/cordfabric/pom.xml
@@ -33,6 +33,12 @@
<properties>
<onos.app.name>org.onosproject.cordfabric</onos.app.name>
<web.context>/onos/cordfabric</web.context>
+ <api.version>1.0.0</api.version>
+ <api.title>ONOS CORD Fabric REST API</api.title>
+ <api.description>
+ APIs for interacting with the CORD Fabric application.
+ </api.description>
+ <api.package>org.onosproject.cordfabric</api.package>
</properties>
<dependencies>
@@ -94,6 +100,10 @@
<configuration>
<instructions>
<_wab>src/main/webapp/</_wab>
+ <Include-Resource>
+ WEB-INF/classes/apidoc/swagger.json=target/swagger.json,
+ {maven-resources}
+ </Include-Resource>
<Bundle-SymbolicName>
${project.groupId}.${project.artifactId}
</Bundle-SymbolicName>
diff --git a/apps/segmentrouting/pom.xml b/apps/segmentrouting/pom.xml
index b549c0e..3ed4c4f 100644
--- a/apps/segmentrouting/pom.xml
+++ b/apps/segmentrouting/pom.xml
@@ -33,6 +33,12 @@
<properties>
<onos.app.name>org.onosproject.segmentrouting</onos.app.name>
<web.context>/onos/segmentrouting</web.context>
+ <api.version>1.0.0</api.version>
+ <api.title>ONOS Segment Routing REST API</api.title>
+ <api.description>
+ APIs for interacting with the Segment Routing application.
+ </api.description>
+ <api.package>org.onosproject.segmentrouting.web</api.package>
</properties>
<dependencies>
@@ -94,6 +100,10 @@
<configuration>
<instructions>
<_wab>src/main/webapp/</_wab>
+ <Include-Resource>
+ WEB-INF/classes/apidoc/swagger.json=target/swagger.json,
+ {maven-resources}
+ </Include-Resource>
<Bundle-SymbolicName>
${project.groupId}.${project.artifactId}
</Bundle-SymbolicName>