added hidden field for subresource support #633

swagger-api · Aug 28, 2014 · d9e4d98 · d9e4d98
1 parent 7a382d0
commit d9e4d98
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 50 deletions.
diff --git a/modules/swagger-core/src/main/scala/com/wordnik/swagger/core/util/ReaderUtil.scala b/modules/swagger-core/src/main/scala/com/wordnik/swagger/core/util/ReaderUtil.scala
@@ -23,7 +23,7 @@ trait ReaderUtil {
     val tuples = listings.map(m => (m.resourcePath, m))
     val grouped = tuples.groupBy(_._1)
     (for (group <- grouped) yield {
-      val apiDescriptions = (for(g <- group._2; api <- g._2.apis) yield api).toList
+      val apiDescriptions = (for(g <- group._2; api <- g._2.apis) yield api).filter(_.hidden == false).toList
       val models = (for(g <- group._2; models <- g._2.models) yield models).flatten.toMap
       group._2(0)._2.copy(apis = apiDescriptions, models = Option(models))
     }).toList

diff --git a/modules/swagger-core/src/main/scala/com/wordnik/swagger/model/SwaggerModels.scala b/modules/swagger-core/src/main/scala/com/wordnik/swagger/model/SwaggerModels.scala
@@ -85,7 +85,8 @@ case class ApiListing (
 case class ApiDescription (
   path: String,
   description: Option[String],
-  operations: List[Operation] = List())
+  operations: List[Operation] = List(),
+  hidden: Boolean = false)
 
 case class Operation (
   method: String,

diff --git a/modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/reader/BasicJaxrsReader.scala b/modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/reader/BasicJaxrsReader.scala
@@ -27,9 +27,13 @@ class BasicJaxrsReader extends JaxrsApiReader {
     parentMethods: ListBuffer[Method]): Option[ApiListing] = {
     val api = cls.getAnnotation(classOf[Api])
     val pathAnnotation = cls.getAnnotation(classOf[Path])
+    var hidden = false
 
     val r = Option(api) match {
-      case Some(api) => api.value
+      case Some(api) => {
+        hidden = api.hidden
+        api.value
+      }
       case None => Option(pathAnnotation) match {
         case Some(p) => p.value
         case None => null
@@ -108,7 +112,8 @@ class BasicJaxrsReader extends JaxrsApiReader {
         ApiDescription(
           addLeadingSlash(endpoint),
           None,
-          orderedOperations.toList)
+          orderedOperations.toList,
+          hidden)
       }).toList
       val models = ModelUtil.modelsFromApis(apis)
       Some(ApiListing (

diff --git a/...es/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/reader/DefaultJaxrsReader.scala b/...es/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/reader/DefaultJaxrsReader.scala
@@ -90,7 +90,8 @@ class DefaultJaxrsApiReader extends JaxrsApiReader {
         ApiDescription(
           addLeadingSlash(endpoint),
           None,
-          orderedOperations.toList)
+          orderedOperations.toList,
+          hidden = api.hidden)
       }).toList
 
       val basePath = {

diff --git a/modules/swagger-jersey-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala b/modules/swagger-jersey-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala
@@ -116,7 +116,8 @@ class JerseyApiReader extends JaxrsApiReader {
         ApiDescription(
           addLeadingSlash(endpoint),
           None,
-          orderedOperations.toList)
+          orderedOperations.toList,
+          api.hidden)
       }).toList
       val models = ModelUtil.modelsFromApis(apis)
       val basePath = {

diff --git a/...les/swagger-jersey2-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala b/...les/swagger-jersey2-jaxrs/src/main/scala/com/wordnik/swagger/jersey/JerseyApiReader.scala
@@ -116,7 +116,8 @@ class JerseyApiReader extends JaxrsApiReader {
         ApiDescription(
           addLeadingSlash(endpoint),
           None,
-          orderedOperations.toList)
+          orderedOperations.toList,
+          api.hidden)
       }).toList
       val models = ModelUtil.modelsFromApis(apis)
       val basePath = {

diff --git a/...va-jaxrs-subresource/src/main/java/com/wordnik/swagger/sample/resource/OwnerResource.java b/...va-jaxrs-subresource/src/main/java/com/wordnik/swagger/sample/resource/OwnerResource.java
@@ -24,7 +24,7 @@
 import javax.ws.rs.*;
 
 @Path("/owner")
-@Api(value = "/owner", description = "Operations about the owners", position = 1)
+@Api(hidden = true, value = "/owner", description = "Operations about the owners", position = 1)
 @Produces("application/json")
 public class OwnerResource {
 	private String petId;

diff --git a/samples/java-jaxrs-subresource/src/test/scala/ResourceListingIT.scala b/samples/java-jaxrs-subresource/src/test/scala/ResourceListingIT.scala