changeset 168:3193c04a9932

Update API spec with proper definitions for long values This patch introduces a metrics and timestamp properties that correctly describe their definition. Reviewed-by: stooke, jerboaa Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-June/023514.html
author Jie Kang <jkang@redhat.com>
date Wed, 07 Jun 2017 10:24:01 -0400
parents 8822a33e3823
children 917366c00614
files services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml services/jvms/src/main/resources/jvms-swagger.yaml
diffstat 3 files changed, 53 insertions(+), 43 deletions(-) [+]
line wrap: on
line diff
--- a/services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml	Wed May 31 18:56:32 2017 -0400
+++ b/services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml	Wed Jun 07 10:24:01 2017 -0400
@@ -66,16 +66,26 @@
       jvmId:
         type: string
       timeStamp:
-        type: integer
-        format: int64
+        $ref: '#/definitions/timestamp'
       collectorName:
         type: string
       runCount:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       wallTime:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
+
+  metric:
+    type: object
+    properties:
+      $numberLong:
+        type: string
+  timestamp:
+    description: UNIX timestamp in milliseconds
+    type: object
+    properties:
+      $numberLong:
+        type: string
+
   put-body:
     type: object
     properties:
--- a/services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml	Wed May 31 18:56:32 2017 -0400
+++ b/services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml	Wed Jun 07 10:24:01 2017 -0400
@@ -66,20 +66,15 @@
       jvmId:
         type: string
       timeStamp:
-        type: integer
-        format: int64
+        $ref: '#/definitions/timestamp'
       metaspaceMaxCapacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       metaspaceMinCapacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       metaspaceCapacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       metaspaceUsed:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       generations:
         type: array
         items:
@@ -88,13 +83,11 @@
     type: object
     properties:
       capacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       collector:
         type: string
       maxCapacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       name:
         type: string
       spaces:
@@ -105,18 +98,27 @@
     type: object
     properties:
       capacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       index:
         type: integer
       maxCapacity:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       name:
         type: string
       used:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
+
+  metric:
+    type: object
+    properties:
+      $numberLong:
+        type: string
+  timestamp:
+    description: UNIX timestamp in milliseconds
+    type: object
+    properties:
+      $numberLong:
+        type: string
 
   put-body:
     type: object
--- a/services/jvms/src/main/resources/jvms-swagger.yaml	Wed May 31 18:56:32 2017 -0400
+++ b/services/jvms/src/main/resources/jvms-swagger.yaml	Wed Jun 07 10:24:01 2017 -0400
@@ -106,11 +106,9 @@
       mainClass:
         type: string
       startTime:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       stopTime:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       jvmPid:
         type: integer
       javaVersion:
@@ -134,13 +132,11 @@
         items:
           $ref: '#/definitions/environment-items'
       uid:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       username:
         type: string
       lastUpdated:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
 
   jvm-post-info:
     type: object
@@ -152,11 +148,9 @@
       mainClass:
         type: string
       startTime:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       stopTime:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       jvmPid:
         type: integer
       javaVersion:
@@ -180,13 +174,11 @@
         items:
           $ref: '#/definitions/environment-items'
       uid:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
       username:
         type: string
       lastUpdated:
-        type: integer
-        format: int64
+        $ref: '#/definitions/metric'
   environment-items:
     type: object
     properties:
@@ -195,6 +187,12 @@
       value:
         type: string
 
+  metric:
+    type: object
+    properties:
+      $numberLong:
+        type: string
+
   jvms-get-response:
     type: object
     properties:
@@ -246,7 +244,7 @@
     required: true
     type: integer
     format: int64
-    description: The timestamp to set the last_updated field for.
+    description: The UNIX timestamp in milliseconds to set the last_updated field for.
   jvms-post-body:
     name: body
     in: body