merged from master

Author: fehguy

README.md

@@ -2,30 +2,26 @@
 
 [![Build Status](https://travis-ci.org/wordnik/swagger-core.png)](https://travis-ci.org/wordnik/swagger-core)
 
-The goal of Swagger is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined via Swagger, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interfaces have done for lower-level programming, Swager removes the guesswork in calling the service.
+## [See the Wiki!](https://github.com/wordnik/swagger-core/wiki)
+The [github wiki](https://github.com/wordnik/swagger-core/wiki) contains documentation, samples, etc.  Start there
 
-Swagger-core is the Java/Scala implementation of Swagger. It supports *JAX-RS*, *plain Servlets*, and *Play Framework*.
-
-Check out [Swagger-Spec](https://github.com/wordnik/swagger-spec) for additional information about the Swagger project, including additional libraries with support for SpringMVC, other languages and more. 
-
-## See the Wiki!
-The [github wiki](https://github.com/wordnik/swagger-core/wiki) contains documentation, samples, etc.  Start there.
-
-## Support
-The following methods are available to obtain support for Swagger:
-
-- [The Swagger Google Group](https://groups.google.com/forum/#!forum/swagger-swaggersocket) - This would normally be your first stop to get support for Swagger. Here you can find previously asked question, and ask new ones. When asking a question, please provide as much information as you can regarding the environment you use (development language, library, versions.
-- The [Issues tab](https://github.com/wordnik/swagger-core/issues?state=open) - Please open feature requests and bugs here. If you're not sure you encountered a bug, or if it's a general usage question, please use the Google Group mentioned above.
-- IRC! you can find us on [freenode](irc://irc.freenode.net) in the channel #Swagger. You can talk with us directly there.
+## Where to get help!
+Search the [swagger google groups](https://groups.google.com/forum/#!forum/swagger-swaggersocket) for previously 
+asked questions.  Join #swagger on irc.freenode.net to talk to interesting human beings.  And if you find a bug,
+file it in github:
 
+* [Swagger core + server integrations](https://github.com/wordnik/swagger-core/issues) issues
+* [Swagger UI](https://github.com/wordnik/swagger-ui/issues)
+* [Swagger codegen](https://github.com/wordnik/swagger-codegen/issues)
 
 ## Get started with Swagger!
 See the guide on [getting started with swagger](https://github.com/wordnik/swagger-core/wiki/Adding-Swagger-to-your-API) to get started with adding swagger to your API.
 
 
 ## Overview
 This is a project to build the swagger-core library, which is required for the Wordnik 
-implementation of the Swagger spec. For more information about Wordnik's APIs, please
+implementation of the Swagger spec.  You can find out more about both the spec and the
+framework at http://swagger.wordnik.com.  For more information about Wordnik's APIs, please
 visit http://developer.wordnik.com.
 
 
@@ -40,7 +36,9 @@ You need the following installed and available in your $PATH:
 
 <li>- Apache maven 3.0.3 or greater (http://maven.apache.org/)
 
-### To build from source (currently 1.3.2)
+<li>- Scala 2.9.1-1 [available here](http://www.scala-lang.org).  Note that 2.9.1 has a defect which causes problems with Jax-RS
+
+### To build from source (currently 1.3.0)
 ```
 # first time building locally
 mvn -N
@@ -64,6 +62,12 @@ There are a number of sample apps in the `samples` folder:
 
 [scala-jaxrs](https://github.com/wordnik/swagger-core/tree/master/samples/scala-jaxrs/README.md) Scala-based swagger server with JAX-RS
 
+[java-alt-resource-listing](https://github.com/wordnik/swagger-core/tree/master/samples/java-alt-resource-listing/README.md) 
+Scala-based swagger server with JAX-RS with an alternate resource listing scheme
+
+[scala-alt-resource-listing](https://github.com/wordnik/swagger-core/tree/master/samples/scala-alt-resource-listing/README.md) 
+Scala-based swagger server with JAX-RS with an alternate resource listing scheme
+
 [scala-jaxrs-apm](https://github.com/wordnik/swagger-core/tree/master/samples/scala-jaxrs-apm/README.md) 
 Scala-based swagger server using wordnik-oss utils for Application Performance Monitoring (APM)
 
@@ -82,6 +86,8 @@ And the [Play2](http://playframework.org) samples:
 
 [scala-play2](https://github.com/wordnik/swagger-core/tree/master/samples/scala-play2) Scala-based Play2 sample app
 
+[scala-play2-no-format](https://github.com/wordnik/swagger-core/tree/master/samples/scala-play2-no-format) Scala-based Play2 sample app without the .{format} in resource listing
+
 To run the Play2 sample apps:
 
 ```
@@ -93,7 +99,7 @@ play run
 License
 -------
 
-Copyright 2014 Reverb Technologies, Inc.
+Copyright 2013 Reverb Technologies, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

modules/swagger-annotations/pom.xml

@@ -3,13 +3,13 @@
   <parent>
     <groupId>com.wordnik</groupId>
     <artifactId>swagger-project_2.10</artifactId>
-    <version>1.3.2</version>
+    <version>1.3.4</version>
     <relativePath>../..</relativePath>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.wordnik</groupId>
   <artifactId>swagger-annotations</artifactId>
-  <version>1.3.2</version>
+  <version>1.3.4</version>
   <packaging>jar</packaging>
   <name>swagger-annotations</name>
 

modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiModelProperty.java

@@ -68,4 +68,9 @@
    * ordering, you should specify property order to keep models consistent across different VM implementations and versions.
    */
   int position() default 0;
+  
+  /**
+   * Allows a model property to be marked as hidden in the swagger model definition
+   */
+  boolean hidden() default false;
 }

modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiOperation.java

@@ -67,4 +67,9 @@
 
   /** authorizations required by this Api */
   Authorization[] authorizations() default @Authorization("");
+
+  /**
+   * Allows an operation to be marked as hidden
+   */
+  boolean hidden() default false;
 }

modules/swagger-core/pom.xml

@@ -2,15 +2,15 @@
   <parent>
     <groupId>com.wordnik</groupId>
     <artifactId>swagger-project_2.10</artifactId>
-    <version>1.3.2</version>
+    <version>1.3.4</version>
     <relativePath>../..</relativePath>
   </parent>
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.wordnik</groupId>
   <artifactId>swagger-core_2.10</artifactId>
   <packaging>jar</packaging>
   <name>swagger-core</name>
-  <version>1.3.2</version>
+  <version>1.3.4</version>
   <build>
     <sourceDirectory>src/main/java</sourceDirectory>
     <defaultGoal>install</defaultGoal>
@@ -80,19 +80,19 @@
     <dependency>
       <groupId>org.json4s</groupId>
       <artifactId>json4s-ext_2.10</artifactId>
-      <version>3.2.4</version>
+      <version>${json4s-version}</version>
       <scope>compile</scope>
     </dependency> 
     <dependency>
       <groupId>org.json4s</groupId>
       <artifactId>json4s-native_2.10</artifactId>
-      <version>3.2.4</version>
+      <version>${json4s-version}</version>
       <scope>compile</scope>
     </dependency>    
     <dependency>
       <groupId>org.json4s</groupId>
       <artifactId>json4s-jackson_2.10</artifactId>
-      <version>3.2.4</version>
+      <version>${json4s-version}</version>
       <scope>compile</scope>
     </dependency>
     <dependency>

modules/swagger-core/src/main/resources/logback.xml

@@ -6,7 +6,7 @@
     </layout>
   </appender>
   <logger name="com.wordnik" level="ERROR"/>
-  <root level="debug">
+  <root level="error">
     <appender-ref ref="STDOUT" />
   </root>
 </configuration>

modules/swagger-core/src/main/scala/com/wordnik/swagger/converter/JodaDateTimeConverter.scala

@@ -17,8 +17,8 @@ class JodaDateTimeConverter extends ModelConverter with BaseConverter {
   // }
   // 
   // (note the keys are lowercase when matching)
-  override def typeMap = Map("datetime" -> "Date")
+  override def typeMap = Map("datetime" -> "Date", "xmlgregoriancalendar" -> "Date")
 
   // don't expand DateTime models
-  override def ignoredClasses: Set[String] = Set("org.joda.time.DateTime")
+  override def ignoredClasses: Set[String] = Set("org.joda.time.DateTime", "javax.xml.datatype.XMLGregorianCalendar")
 }

modules/swagger-core/src/main/scala/com/wordnik/swagger/converter/ModelPropertyParser.scala

@@ -53,14 +53,14 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
   def parseField(field: Field) = {
     LOGGER.debug("processing field " + field)
     val returnClass = field.getDeclaringClass
-    parsePropertyAnnotations(returnClass, field.getName, field.getAnnotations, field.getGenericType, field.getType)
+    parsePropertyAnnotations(returnClass, field.getName, field.getAnnotations, field.getGenericType, field.getType, true)
   }
 
   def parseMethod(method: Method) = {
-    if (method.getParameterTypes == null || method.getParameterTypes.length == 0) {
+    if ((method.getParameterTypes == null || method.getParameterTypes.length == 0) && !method.isBridge) {
       LOGGER.debug("processing method " + method)
       val returnClass = method.getReturnType
-      parsePropertyAnnotations(returnClass, method.getName, method.getAnnotations, method.getGenericReturnType, method.getReturnType)
+      parsePropertyAnnotations(returnClass, method.getName, method.getAnnotations, method.getGenericReturnType, method.getReturnType, false)
     }
   }
 
@@ -78,8 +78,11 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
     }
   }
 
-  def parsePropertyAnnotations(returnClass: Class[_], propertyName: String, propertyAnnotations: Array[Annotation], genericReturnType: Type, returnType: Type): Any = {
-    val e = extractGetterProperty(propertyName)
+  def parsePropertyAnnotations(returnClass: Class[_], propertyName: String, propertyAnnotations: Array[Annotation], genericReturnType: Type, returnType: Type, isField: Boolean): Any = {
+    val e = isField match {
+      case true => (propertyName, false)
+      case false => extractGetterProperty(propertyName)
+    }
     var originalName = e._1
     var isGetter = e._2
 
@@ -103,26 +106,32 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
     var isXmlElement = processedAnnotations("isXmlElement").asInstanceOf[Boolean]
     val isDocumented = processedAnnotations("isDocumented").asInstanceOf[Boolean]
     var allowableValues = {
-      if(returnClass.isEnum) 
+      if(returnClass.isEnum)
         Some(AllowableListValues((for(v <- returnClass.getEnumConstants) yield v.toString).toList))
       else
         processedAnnotations("allowableValues").asInstanceOf[Option[AllowableValues]]
     }
 
     try {
-      val fieldAnnotations = getDeclaredField(this.cls, name).getAnnotations()
-      var propAnnoOutput = processAnnotations(name, fieldAnnotations)
+      val fieldAnnotations = getDeclaredField(this.cls, originalName).getAnnotations()
+      var propAnnoOutput = processAnnotations(originalName, fieldAnnotations)
       var propPosition = propAnnoOutput("position").asInstanceOf[Int]
 
-      if(allowableValues == None) 
+      if (name == null || name.equals(originalName)) {
+        name = propAnnoOutput("name").asInstanceOf[String]
+      }
+
+      if(allowableValues == None)
         allowableValues = propAnnoOutput("allowableValues").asInstanceOf[Option[AllowableValues]]
-      if(description == None && propAnnoOutput.contains("description") && propAnnoOutput("description") != null) 
+      if(description == None && propAnnoOutput.contains("description") && propAnnoOutput("description") != null)
         description = Some(propAnnoOutput("description").asInstanceOf[String])
       if(propPosition != 0) position = propAnnoOutput("position").asInstanceOf[Int]
       if(required == false) required = propAnnoOutput("required").asInstanceOf[Boolean]
       isFieldExists = true
       if (!isTransient) isTransient = propAnnoOutput("isTransient").asInstanceOf[Boolean]
       if (!isXmlElement) isXmlElement = propAnnoOutput("isXmlElement").asInstanceOf[Boolean]
+
+      if (name == null) name = originalName
       isJsonProperty = propAnnoOutput("isJsonProperty").asInstanceOf[Boolean]
     } catch {
       //this means there is no field declared to look for field level annotations.
@@ -226,6 +235,7 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
           isDocumented = true
           allowableValues = Some(toAllowableValues(e.allowableValues))
           paramAccess = readString(e.access)
+          isTransient = e.hidden
         }
         case e: XmlAttribute => {
           updatedName = readString(e.name, name, "##default")
@@ -235,7 +245,6 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
         }
         case e: XmlElement => {
           updatedName = readString(e.name, name, "##default")
-          // updatedName = readString(name, name)
           defaultValue = readString(e.defaultValue, defaultValue, "\u0000")
 
           required = e.required
@@ -253,7 +262,7 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
           updatedName = readString(e.value, name)
           isJsonProperty = true
         }
-        case _ => 
+        case _ =>
       }
     }
     val output = new HashMap[String, Any]
@@ -349,10 +358,6 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
       val parameterizedType = genericReturnType.asInstanceOf[java.lang.reflect.ParameterizedType]
       val valueType = parameterizedType.getActualTypeArguments.head
       "Set[" + getDataType(valueType, valueType, isSimple) + "]"
-    } else if (TypeUtil.isParameterizedCollection(genericReturnType)) {
-      val parameterizedType = genericReturnType.asInstanceOf[java.lang.reflect.ParameterizedType]
-      val valueType = parameterizedType.getActualTypeArguments.head
-      "Array[" + getDataType(valueType, valueType, isSimple) + "]"
     } else if (TypeUtil.isParameterizedMap(genericReturnType)) {
       val parameterizedType = genericReturnType.asInstanceOf[java.lang.reflect.ParameterizedType]
       val typeArgs = parameterizedType.getActualTypeArguments
@@ -402,7 +407,7 @@ class ModelPropertyParser(cls: Class[_], t: Map[String, String] = Map.empty) (im
         else hostClass.getName
       } else if (xmlRootElement != null) {
         if ("##default".equals(xmlRootElement.name())) {
-          if (isSimple) hostClass.getSimpleName 
+          if (isSimple) hostClass.getSimpleName
           else hostClass.getName
         } else {
           if (isSimple) readString(xmlRootElement.name())

modules/swagger-core/src/main/scala/com/wordnik/swagger/converter/SwaggerSchemaConverter.scala

@@ -28,12 +28,12 @@ class SwaggerSchemaConverter
           }
         }
         newProperties ++= properties
-        val p = (for((key, value) <- newProperties.reverse)
+        val p = (for((key, value) <- newProperties)
           yield (value.position, key, value)
         ).toList
 
         val sortedProperties = new LinkedHashMap[String, ModelProperty]()
-        p.sortWith(_._1 <= _._1).foreach(e => sortedProperties += e._2 -> e._3)
+        p.sortWith(_._1 < _._1).foreach(e => sortedProperties += e._2 -> e._3)
 
         val parent = Option(cls.getAnnotation(classOf[ApiModel])) match {
           case Some(e) => Some(e.parent.getName)
@@ -46,7 +46,7 @@ class SwaggerSchemaConverter
               apiAnno.discriminator
             else if(cls.getAnnotation(classOf[JsonTypeInfo]) != null)
               cls.getAnnotation(classOf[JsonTypeInfo]).property
-            else ""
+            else "" 
           }
           if(v != null && v != "") Some(v)
           else None

modules/swagger-core/src/main/scala/com/wordnik/swagger/core/util/TypeUtil.scala

@@ -62,15 +62,7 @@ object TypeUtil {
   def isParameterizedList(gt: Type): Boolean = {
     if (classOf[ParameterizedType].isAssignableFrom(gt.getClass)) {
       val tp = gt.asInstanceOf[ParameterizedType].getRawType
-        (tp == classOf[java.util.List[_]] || tp == classOf[scala.List[_]] || tp == classOf[Seq[_]])
-    }
-    else false
-  }
-
-  def isParameterizedCollection(gt: Type): Boolean = {
-    if (classOf[ParameterizedType].isAssignableFrom(gt.getClass)) {
-      val tp = gt.asInstanceOf[ParameterizedType].getRawType
-      (tp == classOf[java.util.Collection[_]])
+      (tp == classOf[java.util.List[_]] || tp == classOf[scala.List[_]] || tp == classOf[Seq[_]])
     }
     else false
   }