Mercurial > hg > thermostat-ng > web-gateway

changeset 262:fe616d82ac59

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix Swagger inconsistencies After running the SwaggerCombine utility on all our Swagger files, several inconsistencies were found in our in our API definitions. The main ones were - 'ref' used instead of '$ref' - query parameter 'offset' marked as mandatory. - missing defaults This patch fixes all such inconsistencies. In addition, a missing definition of jvm-id was re-added in the jvm-gc Swagger YAML. Reviewed-by: clessard, sgehwolf Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-September/025110.html
author Simon Tooke <stooke@redhat.com>
date Tue, 19 Sep 2017 09:19:10 -0400
parents d4290a3f1e03
children 2d35ee835941
files services/jvm-cpu/src/main/resources/jvm-cpu-swagger.yaml services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml services/jvm-io/src/main/resources/jvm-io-swagger.yaml services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml services/system-cpu/src/main/resources/system-cpu-swagger.yaml services/system-memory/src/main/resources/system-memory-swagger.yaml services/system-network/src/main/resources/system-network-swagger.yaml services/systems/src/main/resources/systems-swagger.yaml
diffstat 8 files changed, 32 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/services/jvm-cpu/src/main/resources/jvm-cpu-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/jvm-cpu/src/main/resources/jvm-cpu-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -160,7 +160,7 @@
     in: query
     description: Offset of items to return. Example '0'
     type: integer
-    required: true
+    required: false
     default: 0
   sort:
     name: sort
--- a/services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/jvm-gc/src/main/resources/jvm-gc-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -194,6 +194,11 @@
     in: path
     required: true
     type: string
+  jvm-id:
+    name: jvmId
+    in: path
+    required: true
+    type: string
   jvm-gc-stats:
     name: jvm-gc-stats
     in: body
@@ -212,21 +217,27 @@
     name: limit
     in: query
     description: Limit of items to return. Example '1'
+    required: false
+    default: 1
     type: integer
   offset:
     name: offset
     in: query
     description: Offset of items to return. Example '0'
+    required: false
+    default: 0
     type: integer
   sort:
     name: sort
     in: query
     description: Sort string. Comma separated list of fields prefixed with '+' for ascending or '-' for descending. Example '?s=+a,-b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.
+    required: false
     type: string
   query:
     name: query
     in: query
     description: Query string. Comma separated list of key, comparator, value pairs. Comparator supports '==', '<=', '>=', '<', '>', '!='. Example '?q=a==b,c!=d'. Keys are fields in documents and use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.
+    required: false
     type: string
   include:
     name: include
--- a/services/jvm-io/src/main/resources/jvm-io-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/jvm-io/src/main/resources/jvm-io-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -102,13 +102,13 @@
       timeStamp:
         $ref: '#/definitions/timestamp'
       charactersRead:
-        ref: '#/definitions/metric'
+        $ref: '#/definitions/metric'
       charactersWritten:
-        ref: '#/definitions/metric'
+        $ref: '#/definitions/metric'
       readSyscalls:
-        ref: '#/definitions/metric'
+        $ref: '#/definitions/metric'
       writeSyscalls:
-       ref: '#/definitions/metric'
+        $ref: '#/definitions/metric'
   metadata:
       type: object
       properties:
@@ -176,22 +176,28 @@
     name: limit
     in: query
     description: Limit of items to return. Example '1'
+    required: false
     type: integer
+    default: 1
   offset:
     name: offset
     in: query
     description: Offset of items to return. Example '0'
+    required: false
     type: integer
+    default: 0
   sort:
     name: sort
     in: query
     description: Sort string. Comma separated list of fields prefixed with '+' for ascending or '-' for descending. Example '?s=+a,-b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.
     type: string
+    required: false
   query:
     name: query
     in: query
     description: Query string. Comma separated list of key, comparator, value pairs. Comparator supports '==', '<=', '>=', '<', '>', '!='. Example '?q=a==b,c!=d'. Keys are fields in documents and use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.
     type: string
+    required: false
   include:
     name: include
     in: query
--- a/services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/jvm-memory/src/main/resources/jvm-memory-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -210,21 +210,27 @@
     in: query
     description: Limit of items to return. Example '1'
     type: integer
+    default: 1
+    required: false
   offset:
     name: offset
     in: query
     description: Offset of items to return. Example '0'
     type: integer
+    required: false
+    default: 0
   sort:
     name: sort
     in: query
     description: Sort string. Comma separated list of fields prefixed with '+' for ascending or '-' for descending. Example '?s=+a,-b' Fields use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.
     type: string
+    required: false
   query:
     name: query
     in: query
     description: Query string. Comma separated list of key, comparator, value pairs. Comparator supports '==', '<=', '>=', '<', '>', '!='. Example '?q=a==b,c!=d'. Keys are fields in documents and use dot notation for embedded documents. Example 'outer.inner' refers to field inner contained in field outer.
     type: string
+    required: false
   include:
     name: include
     in: query
--- a/services/system-cpu/src/main/resources/system-cpu-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/system-cpu/src/main/resources/system-cpu-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -117,7 +117,7 @@
     in: query
     description: Offset of items to return. Example '0'
     type: integer
-    required: true
+    required: false
     default: 0
   sort:
     name: sort
--- a/services/system-memory/src/main/resources/system-memory-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/system-memory/src/main/resources/system-memory-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -133,7 +133,7 @@
     in: query
     description: Offset of items to return. Example '0'
     type: integer
-    required: true
+    required: false
     default: 0
   sort:
     name: sort
--- a/services/system-network/src/main/resources/system-network-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/system-network/src/main/resources/system-network-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -127,7 +127,7 @@
     in: query
     description: Offset of items to return. Example '0'
     type: integer
-    required: true
+    required: false
     default: 0
   sort:
     name: sort
--- a/services/systems/src/main/resources/systems-swagger.yaml	Wed Sep 13 13:32:57 2017 +0200
+++ b/services/systems/src/main/resources/systems-swagger.yaml	Tue Sep 19 09:19:10 2017 -0400
@@ -154,7 +154,7 @@
     in: query
     description: Offset of items to return. Example '0'
     type: integer
-    required: true
+    required: false
     default: 0
   sort:
     name: sort