HWKMETRICS-255 Upgrade to Swagger 1.5

- Artifact and package names changed
- Dropped the Mustache template and generate document from JSON with Groovy
- Fixed doc issues here and there
- Removed annotations from JAX-RS 1.1 module (not used)

The doc is in better shape now :
 - no broken links
 - better representation of arrays and allowable values
 - new format column

api/metrics-api-common/pom.xml

@@ -102,15 +102,10 @@
 
     <!-- documentation -->
     <dependency>
-      <groupId>com.wordnik</groupId>
+      <groupId>io.swagger</groupId>
       <artifactId>swagger-annotations</artifactId>
       <scope>provided</scope>
     </dependency>
-    <dependency>
-      <groupId>com.wordnik</groupId>
-      <artifactId>swagger-core_2.10</artifactId>
-      <scope>provided</scope>
-    </dependency>
 
   </dependencies>
 

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/ApiError.java → api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/ApiError.java

@@ -14,11 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.hawkular.metrics.api.jaxrs;
+package org.hawkular.metrics.api.jaxrs.model;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 
 /**
  * Return information what failed in the REST-call.
@@ -34,7 +35,7 @@ public ApiError(String errorMsg) {
         this.errorMsg = errorMsg != null && !errorMsg.trim().isEmpty() ? errorMsg : "No details";
     }
 
-    @ApiModelProperty(value = "Detailed error message of what happened")
+    @ApiModelProperty(value = "Detailed error message of what happened", required = true)
     public String getErrorMsg() {
         return errorMsg;
     }

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/Availability.java

@@ -35,9 +35,9 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import rx.Observable;
 
 /**

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/AvailabilityDataPoint.java

@@ -38,9 +38,9 @@
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
 import com.google.common.collect.Lists;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import rx.Observable;
 
 /**
@@ -84,7 +84,7 @@ public long getTimestamp() {
         return timestamp;
     }
 
-    @ApiModelProperty(allowableValues = "[up,down,unknown]", required = true)
+    @ApiModelProperty(required = true, dataType = "string", allowableValues = "up,down,unknown")
     @JsonSerialize(using = AvailabilityTypeSerializer.class)
     @org.codehaus.jackson.map.annotate.JsonSerialize(
             using = org.hawkular.metrics.api.jaxrs.codehaus.jackson.AvailabilityTypeSerializer.class

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/Counter.java

@@ -34,9 +34,9 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import rx.Observable;
 
 /**

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/CounterDataPoint.java

@@ -36,9 +36,9 @@
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
 import com.google.common.collect.Lists;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import rx.Observable;
 
 /**

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/Gauge.java

@@ -34,9 +34,9 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import rx.Observable;
 
 /**

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/GaugeDataPoint.java

@@ -36,9 +36,9 @@
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
 import com.google.common.collect.Lists;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
 
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 import rx.Observable;
 
 /**

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/MetricDefinition.java

@@ -34,19 +34,20 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 
 /**
  * @author John Sanda
  */
 @ApiModel(value = "Metric", description = "The definition of a metric")
-public class MetricDefinition<T> {
+public class MetricDefinition {
     private final String tenantId;
     private final String id;
     private final Map<String, String> tags;
     private final Integer dataRetention;
-    private final MetricType<T> type;
+    private final MetricType<?> type;
 
     @JsonCreator(mode = Mode.PROPERTIES)
     @org.codehaus.jackson.annotate.JsonCreator
@@ -67,7 +68,7 @@ public MetricDefinition(
             @org.codehaus.jackson.map.annotate.JsonDeserialize(
                     using = org.hawkular.metrics.api.jaxrs.codehaus.jackson.MetricTypeDeserializer.class
             )
-            MetricType<T> type
+            MetricType<?> type
     ) {
         checkArgument(id != null, "Metric id is null");
         this.tenantId = null;
@@ -77,7 +78,7 @@ public MetricDefinition(
         this.type = type;
     }
 
-    public MetricDefinition(Metric<T> metric) {
+    public MetricDefinition(Metric<?> metric) {
         this.tenantId = metric.getId().getTenantId();
         this.id = metric.getId().getName();
         this.type = metric.getId().getType();
@@ -109,12 +110,12 @@ public Integer getDataRetention() {
         return dataRetention;
     }
 
-    @ApiModelProperty("Metric type")
+    @ApiModelProperty(value = "Metric type", dataType = "string", allowableValues = "gauge, availability, counter")
     @JsonSerialize(using = MetricTypeSerializer.class)
     @org.codehaus.jackson.map.annotate.JsonSerialize(
             using = org.hawkular.metrics.api.jaxrs.codehaus.jackson.MetricTypeSerializer.class
     )
-    public MetricType<T> getType() {
+    public MetricType<?> getType() {
         return type;
     }
 
@@ -126,7 +127,7 @@ public boolean equals(Object o) {
         if (o == null || getClass() != o.getClass()) {
             return false;
         }
-        MetricDefinition<?> that = (MetricDefinition<?>) o;
+        MetricDefinition that = (MetricDefinition) o;
         return id.equals(that.id) && type == that.type;
     }
 

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/MixedMetricsRequest.java

@@ -23,9 +23,11 @@
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonCreator.Mode;
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.Objects;
-import com.wordnik.swagger.annotations.ApiModel;
+
+import io.swagger.annotations.ApiModel;
 
 /**
  * @author Stefan Negrea
@@ -70,6 +72,8 @@ public List<Counter> getCounters() {
     /**
      * @return true if this instance has no data point (of any type)
      */
+    @JsonIgnore
+    @org.codehaus.jackson.annotate.JsonIgnore
     public boolean isEmpty() {
         return gauges.isEmpty() && availabilities.isEmpty() && counters.isEmpty();
     }

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/TagRequest.java

@@ -25,7 +25,8 @@
 import com.fasterxml.jackson.annotation.JsonCreator.Mode;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.google.common.base.Objects;
-import com.wordnik.swagger.annotations.ApiModel;
+
+import io.swagger.annotations.ApiModel;
 
 /**
  * @author John Sanda

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/model/TenantDefinition.java

@@ -34,8 +34,9 @@
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize;
 import com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 
 /**
  * @author John Sanda

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/util/ApiUtils.java

@@ -22,7 +22,7 @@
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
 
-import org.hawkular.metrics.api.jaxrs.ApiError;
+import org.hawkular.metrics.api.jaxrs.model.ApiError;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

api/metrics-api-common/src/main/java/org/hawkular/metrics/api/jaxrs/util/StringValue.java

@@ -19,11 +19,12 @@
 import javax.xml.bind.annotation.XmlAttribute;
 import javax.xml.bind.annotation.XmlRootElement;
 
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
 
 /**
- * Encapsulate a simple string value
+ * Encapsulate a simple string value.
+ *
  * @author Heiko W. Rupp
  */
 @ApiModel(value = "Encapsulates a simple string value. In XML this is represented as <value value=\"...\"/>")

api/metrics-api-jaxrs-1.1/pom.xml

@@ -85,18 +85,6 @@
       <artifactId>cdi-api</artifactId>
       <scope>provided</scope>
     </dependency>
-
-    <!-- documentation -->
-    <dependency>
-      <groupId>com.wordnik</groupId>
-      <artifactId>swagger-annotations</artifactId>
-      <scope>provided</scope>
-    </dependency>
-    <dependency>
-      <groupId>com.wordnik</groupId>
-      <artifactId>swagger-core_2.10</artifactId>
-      <scope>provided</scope>
-    </dependency>
   </dependencies>
 
   <repositories>

api/metrics-api-jaxrs-1.1/src/main/java/org/hawkular/metrics/api/jaxrs/exception/mappers/ExceptionMapperUtils.java

@@ -21,7 +21,7 @@
 import javax.ws.rs.core.Response.ResponseBuilder;
 import javax.ws.rs.core.Response.Status;
 
-import org.hawkular.metrics.api.jaxrs.ApiError;
+import org.hawkular.metrics.api.jaxrs.model.ApiError;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

api/metrics-api-jaxrs-1.1/src/main/java/org/hawkular/metrics/api/jaxrs/filter/MetricsServiceStateFilter.java

@@ -24,10 +24,10 @@
 import javax.ws.rs.core.Response.Status;
 import javax.ws.rs.ext.Provider;
 
-import org.hawkular.metrics.api.jaxrs.ApiError;
 import org.hawkular.metrics.api.jaxrs.MetricsServiceLifecycle;
 import org.hawkular.metrics.api.jaxrs.MetricsServiceLifecycle.State;
 import org.hawkular.metrics.api.jaxrs.handler.StatusHandler;
+import org.hawkular.metrics.api.jaxrs.model.ApiError;
 import org.jboss.resteasy.annotations.interception.ServerInterceptor;
 import org.jboss.resteasy.core.ResourceMethod;
 import org.jboss.resteasy.core.ServerResponse;

api/metrics-api-jaxrs-1.1/src/main/java/org/hawkular/metrics/api/jaxrs/filter/TenantFilter.java

@@ -25,10 +25,10 @@
 import javax.ws.rs.core.Response.Status;
 import javax.ws.rs.ext.Provider;
 
-import org.hawkular.metrics.api.jaxrs.ApiError;
 import org.hawkular.metrics.api.jaxrs.handler.BaseHandler;
 import org.hawkular.metrics.api.jaxrs.handler.StatusHandler;
 import org.hawkular.metrics.api.jaxrs.handler.VirtualClockHandler;
+import org.hawkular.metrics.api.jaxrs.model.ApiError;
 import org.jboss.resteasy.annotations.interception.ServerInterceptor;
 import org.jboss.resteasy.core.ResourceMethod;
 import org.jboss.resteasy.core.ServerResponse;