Map support for ResponseHeader#responseContainer() has been remooved. Fixes #1032

Author: lugaru1234

modules/swagger-jaxrs/src/main/java/com/wordnik/swagger/jaxrs/Reader.java

@@ -367,7 +367,8 @@ public Map<String, Property> parseResponseHeaders(com.wordnik.swagger.annotation
           if(!cls.equals(java.lang.Void.class) && !"void".equals(cls.toString())) {
             Property property = ModelConverters.getInstance().readAsProperty(cls);
             if(property != null) {
-              Property responseProperty = wrapContainer(header.responseContainer(), property);
+              Property responseProperty = ContainerWrapper.wrapContainer(header.responseContainer(), property,
+                ContainerWrapper.ARRAY, ContainerWrapper.LIST, ContainerWrapper.SET);
               responseProperty.setDescription(description);
               responseHeaders.put(name, responseProperty);
             }
@@ -455,7 +456,7 @@ public Operation parseMethod(Method method) {
       if(isPrimitive(responseClass)) {
         Property property = ModelConverters.getInstance().readAsProperty(responseClass);
         if(property != null) {
-          Property responseProperty = wrapContainer(responseContainer, property);
+          Property responseProperty = ContainerWrapper.wrapContainer(responseContainer, property);
           operation.response(responseCode, new Response()
             .description(SUCCESSFUL_OPERATION)
             .schema(responseProperty)
@@ -473,7 +474,7 @@ else if(!responseClass.equals(java.lang.Void.class) && !"void".equals(responseCl
         }
         for(String key: models.keySet()) {
           Property property = new RefProperty().asDefault(key);
-          Property responseProperty = wrapContainer(responseContainer, property);
+          Property responseProperty = ContainerWrapper.wrapContainer(responseContainer, property);
           operation.response(responseCode, new Response()
             .description(SUCCESSFUL_OPERATION)
             .schema(responseProperty)
@@ -527,7 +528,7 @@ else if(!responseClass.equals(java.lang.Void.class) && !"void".equals(responseCl
           Map<String, Model> models = ModelConverters.getInstance().read(responseClass);
           for(String key: models.keySet()) {
             Property property =  new RefProperty().asDefault(key);
-            Property responseProperty = wrapContainer(apiResponse.responseContainer(), property);
+            Property responseProperty = ContainerWrapper.wrapContainer(apiResponse.responseContainer(), property);
             response.schema(responseProperty);
             swagger.model(key, models.get(key));
           }
@@ -568,19 +569,6 @@ else if(!responseClass.equals(java.lang.Void.class) && !"void".equals(responseCl
     return operation;
   }
 
-  private Property wrapContainer(String container, Property property) {
-    if ("list".equalsIgnoreCase(container) || "array".equalsIgnoreCase(container)) {
-      return new ArrayProperty(property);
-    } else if ("set".equalsIgnoreCase(container)) {
-      ArrayProperty arrayProperty = new ArrayProperty(property);
-      arrayProperty.setUniqueItems(true);
-      return arrayProperty;
-    } else if ("map".equalsIgnoreCase(container)) {
-      return new MapProperty(property);
-    }
-    return property;
-  }
-
   List<Parameter> getParameters(Class<?> cls, Type type, Annotation[] annotations) {
     // look for path, query
     boolean isArray = ParameterUtils.isMethodArgumentAnArray(cls, type);
@@ -682,4 +670,60 @@ private static Set<Scheme> parseSchemes(String schemes) {
     }
     return result;
   }
+
+  enum ContainerWrapper {
+    LIST("list") {
+      @Override
+      protected Property doWrap(Property property) {
+        return new ArrayProperty(property);
+      }
+    },
+    ARRAY("array") {
+      @Override
+      protected Property doWrap(Property property) {
+        return new ArrayProperty(property);
+      }
+    },
+    MAP("map") {
+      @Override
+      protected Property doWrap(Property property) {
+        return new MapProperty(property);
+      }
+    },
+    SET("set") {
+      @Override
+      protected Property doWrap(Property property) {
+        ArrayProperty arrayProperty = new ArrayProperty(property);
+        arrayProperty.setUniqueItems(true);
+        return arrayProperty;
+      }
+    };
+
+    private final String container;
+
+    ContainerWrapper(String container) {
+      this.container = container;
+    }
+
+    public Property wrap(String container, Property property) {
+      if (this.container.equalsIgnoreCase(container)) {
+        return doWrap(property);
+      }
+      return null;
+    }
+
+    public static Property wrapContainer(String container, Property property, ContainerWrapper... allowed) {
+      final Set<ContainerWrapper> tmp = allowed.length > 0 ? EnumSet.copyOf(Arrays.asList(allowed)) : EnumSet.allOf(ContainerWrapper.class);
+      for (ContainerWrapper wrapper : tmp) {
+        final Property prop = wrapper.wrap(container, property);
+        if (prop != null) {
+          return prop;
+        }
+      }
+      return property;
+    }
+
+    protected abstract Property doWrap(Property property);
+  }
+
 }

modules/swagger-jaxrs/src/test/scala/SimpleScannerTest.scala

@@ -255,7 +255,7 @@ class SimpleScannerTest extends FlatSpec with Matchers {
     val responses5 = paths2.getGet.getResponses;
     responses5.get("203").getSchema().getClass() should be (classOf[ArrayProperty])
     responses5.get("203").getSchema().asInstanceOf[ArrayProperty].getUniqueItems() should be (null)
-    responses5.get("203").getHeaders().get("foo").getClass() should be (classOf[MapProperty])
+    responses5.get("203").getHeaders().get("foo").getClass() should not be (classOf[MapProperty])
     responses5.get("403").getSchema().getClass() should be (classOf[ArrayProperty])
     responses5.get("403").getSchema().asInstanceOf[ArrayProperty].getUniqueItems().booleanValue() should be (true)