Added missing response=ApiError.class attributes in REST documentation

hawkular · Mar 18, 2015 · 0f4ed7c · 0f4ed7c
1 parent 277a991
commit 0f4ed7c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/api/metrics-api-jaxrs/src/main/java/org/hawkular/metrics/api/jaxrs/MetricHandler.java b/api/metrics-api-jaxrs/src/main/java/org/hawkular/metrics/api/jaxrs/MetricHandler.java
@@ -96,8 +96,9 @@ public class MetricHandler {
             + "specify tags and data retention.")
     @ApiResponses(value = {
             @ApiResponse(code = 201, message = "Metric definition created successfully"),
-            @ApiResponse(code = 400, message = "Missing or invalid payload"),
-            @ApiResponse(code = 409, message = "Numeric metric with given id already exists"),
+            @ApiResponse(code = 400, message = "Missing or invalid payload", response = ApiError.class),
+            @ApiResponse(code = 409, message = "Numeric metric with given id already exists",
+                         response = ApiError.class),
             @ApiResponse(code = 500, message = "Metric definition creation failed due to an unexpected error",
                          response = ApiError.class)
     })
@@ -125,8 +126,9 @@ public void createNumericMetric(@Suspended final AsyncResponse asyncResponse,
     @ApiOperation(value = "Create availability metric definition. Same notes as creating numeric metric apply.")
     @ApiResponses(value = {
             @ApiResponse(code = 201, message = "Metric definition created successfully"),
-            @ApiResponse(code = 400, message = "Missing or invalid payload"),
-            @ApiResponse(code = 409, message = "Numeric metric with given id already exists"),
+            @ApiResponse(code = 400, message = "Missing or invalid payload", response = ApiError.class),
+            @ApiResponse(code = 409, message = "Numeric metric with given id already exists",
+                         response = ApiError.class),
             @ApiResponse(code = 500, message = "Metric definition creation failed due to an unexpected error",
                          response = ApiError.class)
     })

diff --git a/api/metrics-api-jaxrs/src/main/java/org/hawkular/metrics/api/jaxrs/TenantsHandler.java b/api/metrics-api-jaxrs/src/main/java/org/hawkular/metrics/api/jaxrs/TenantsHandler.java
@@ -69,8 +69,10 @@ public class TenantsHandler {
             + "are no tenant id naming collisions and to provide default data retention settings. ")
     @ApiResponses(value = {
             @ApiResponse(code = 201, message = "Tenant has been succesfully created."),
-            @ApiResponse(code = 400, message = "Missing or invalid retention properties. "),
-            @ApiResponse(code = 409, message = "Given tenant id has already been created."),
+            @ApiResponse(code = 400, message = "Missing or invalid retention properties. ",
+                         response = ApiError.class),
+            @ApiResponse(code = 409, message = "Given tenant id has already been created.",
+                         response = ApiError.class),
             @ApiResponse(code = 500, message = "An unexpected error occured while trying to create a tenant.",
                          response = ApiError.class)
     })