added example and trueType

clatko · Oct 30, 2014 · ce72413 · ce72413
1 parent 9cf2814
commit ce72413
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 5 deletions.
diff --git a/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/Api.java b/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/Api.java
@@ -33,6 +33,8 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Inherited
 public @interface Api {
+    String apiVersion() default "";
+
     /**
      * The 'path' that is going to be used to host the API Declaration of the
      * resource.
@@ -116,4 +118,5 @@
      * @since 1.3.8
      */
     boolean hidden() default false;
+
 }
diff --git a/...s/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiImplicitParam.java b/...s/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiImplicitParam.java
@@ -107,4 +107,5 @@
      * Valid values are {@code path}, {@code query}, {@code body}, {@code header} or {@code form}.
      */
     String paramType() default "";
+    String trueType() default "";
 }
diff --git a/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiOperation.java b/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiOperation.java
@@ -42,6 +42,7 @@
      * A verbose description of the operation.
      */
     String notes() default "";
+    String example() default "";
 
     /**
      * The response type of the operation.

diff --git a/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiParam.java b/modules/swagger-annotations/src/main/java/com/wordnik/swagger/annotations/ApiParam.java
@@ -37,6 +37,7 @@
      * as the path section they represent.
      */
     String name() default "";
+    String trueType() default "";
 
     /**
      * A brief description of the parameter.

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
@@ -92,6 +92,7 @@ case class Operation (
   method: String,
   summary: String,
   notes: String,
+  example: String,
   responseClass: String,
   nickname: String,
   position: Int,
@@ -112,6 +113,7 @@ case class Parameter (
   dataType: String,
   allowableValues: AllowableValues = AnyAllowableValues,
   paramType: String,
+  trueType: String,
   paramAccess: Option[String] = None)
 
 case class ResponseMessage (

diff --git a/modules/swagger-core/src/main/scala/com/wordnik/swagger/model/SwaggerSerializers.scala b/modules/swagger-core/src/main/scala/com/wordnik/swagger/model/SwaggerSerializers.scala
@@ -191,6 +191,7 @@ object SwaggerSerializers extends Serializers {
         }),
         (json \ "summary").extract[String],
         (json \ "notes").extractOrElse(""),
+        (json \ "example").extract[String],
         (json \ "responseClass").extractOrElse({
           !!(json, OPERATION, "responseClass", "missing required field", ERROR)
           ""
@@ -217,6 +218,7 @@ object SwaggerSerializers extends Serializers {
       ("method" -> x.method) ~
       ("summary" -> x.summary) ~
       ("notes" -> x.notes) ~
+      ("example" -> x.example) ~
       output ~
       ("nickname" -> x.nickname) ~
       ("produces" -> {
@@ -387,6 +389,7 @@ object SwaggerSerializers extends Serializers {
           !!(json, OPERATION_PARAM, "type", "missing required field", ERROR)
           ""
         }),
+        (json \ "trueType").extract[String],
         (json \ "paramAccess").extractOpt[String]
       )
     }, {
@@ -399,6 +402,7 @@ object SwaggerSerializers extends Serializers {
       ("required" -> x.required) ~
       toJsonSchema("type", x.dataType) ~
       ("paramType" -> x.paramType) ~
+      ("trueType" -> x.trueType) ~
       ("allowMultiple" -> x.allowMultiple) ~
       ("paramAccess" -> x.paramAccess)
 
@@ -472,7 +476,8 @@ trait Serializers {
         (json \ "protocols").extractOrElse(List()),
         authorizations,
         (json \ "apis").extract[List[ApiDescription]],
-        (json \ "models").extractOpt[Map[String, Model]]
+        (json \ "models").extractOpt[Map[String, Model]],
+        (json \ "description").extractOpt[String]
       )
     }, {
       case x: ApiListing =>
@@ -521,7 +526,8 @@ trait Serializers {
           case Some(e: Map[String, Model]) if (e.size > 0) => Extraction.decompose(e)
           case _ => JNothing
         }
-      })
+      }) ~
+      ("description" -> x.description)
     }
   ))
 
@@ -707,6 +713,7 @@ trait Serializers {
         }),
         (json \ "summary").extract[String],
         (json \ "notes").extractOrElse(""),
+        (json \ "example").extract[String],
         (json \ "responseClass").extractOrElse({
           !!(json, OPERATION, "responseClass", "missing required field", ERROR)
           ""
@@ -730,6 +737,7 @@ trait Serializers {
       ("method" -> x.method) ~
       ("summary" -> x.summary) ~
       ("notes" -> x.notes) ~
+      ("example" -> x.example) ~
       ("responseClass" -> x.responseClass) ~
       ("nickname" -> x.nickname) ~
       ("produces" -> {
@@ -805,6 +813,7 @@ trait Serializers {
           !!(json, OPERATION_PARAM, "paramType", "missing required field", ERROR)
           ""
         }),
+        (json \ "trueType").extract[String],
         (json \ "paramAccess").extractOpt[String]
       )
     }, {
@@ -825,6 +834,7 @@ trait Serializers {
         }
       }) ~
       ("paramType" -> x.paramType) ~
+      ("trueType" -> x.trueType) ~
       ("paramAccess" -> x.paramAccess)
     }
   ))

diff --git a/modules/swagger-core/src/test/scala/filter/TestSpecs.scala b/modules/swagger-core/src/test/scala/filter/TestSpecs.scala
@@ -18,8 +18,8 @@ object TestSpecs {
   def ordered = {
     val apis = List(
       ApiDescription("/", None, List(
-        Operation("GET", "does something", "notes", "void", "getSomething", 2),
-        Operation("POST", "does something else", "notes", "void", "postSomething", 1)
+        Operation("GET", "does something", "notes", "example", "void", "getSomething", 2),
+        Operation("POST", "does something else", "notes", "example", "void", "postSomething", 1)
         )
       )
     )
@@ -35,7 +35,7 @@ object TestSpecs {
   def subTypes = {
     val apis = List(
       ApiDescription("/", None, List(
-        Operation("GET", "does something", "notes", "Animal", "getSomething", 2))
+        Operation("GET", "does something", "notes", "example", "Animal", "getSomething", 2))
       )
     )
     val models = Some(ModelConverters.readAll(classOf[Animal]).map(m => m.name -> m).toMap)