updated swagger and unified a few parameter names

[netdata.git] / web / netdata-swagger.yaml

diff --git a/web/netdata-swagger.yaml b/web/netdata-swagger.yaml
index 707d17f2bcb4761442c7ff0c4538c943868ea8ca..479818b7dcdcecdb34381eabdd97f7780cf07878 100755 (executable)
--- a/web/netdata-swagger.yaml
+++ b/web/netdata-swagger.yaml
@@ -3,6 +3,7 @@ info:
   title: NetData API
   description: 'Real time monitoring for linux, over the web!'
   version: 1.0.0
+host: 195.97.5.206:19999
 schemes:
   - http
 basePath: /api/v1
@@ -31,6 +32,7 @@ paths:
           required: true
           type: string
           format: 'as returned by /charts'
+          default: 'system.cpu'
       responses:
         '200':
           description: 'A javascript object with detailed information about the chart.'
@@ -51,6 +53,7 @@ paths:
           type: string
           format: 'as returned by /charts'
           allowEmptyValue: false
+          default: system.cpu
         - name: dimension
           in: query
           description: 'zero, one or more dimension ids, as returned by the /chart call.'
@@ -84,14 +87,14 @@ paths:
           type: number
           format: integer
           allowEmptyValue: false
-          default: 100
+          default: 20
         - name: group
           in: query
           description: 'The grouping method. If multiple collected values are to be grouped in order to return fewer points, this parameters defines the method of grouping. Two methods are supported, "max" and "average". "max" is actually calculated on the absolute value collected (so it works for both positive and negative dimesions to return the most extreme value in either direction).'
           required: true
           type: string
           enum: [ 'max', 'average' ]
-          default: 'max'
+          default: 'average'
           allowEmptyValue: false
         - name: format
           in: query
@@ -111,13 +114,25 @@ paths:
             enum: [ 'nonzero', 'flip', 'jsonwrap', 'min2max', 'seconds', 'milliseconds', 'abs', 'absolute', 'absolute-sum', 'null2zero', 'objectrows', 'google_json' ]
             collectionFormat: pipes
             format: ''
+          default: seconds|jsonwrap
+          allowEmptyValue: false
+        - name: callback
+          in: query
+          description: 'For JSONP responses, the callback function name.'
+          required: false
+          type: string
+          allowEmptyValue: false
+        - name: filename
+          in: query
+          description: 'Add Content-Disposition: attachment; filename=<filename> header to the response, that will instruct the browser to save the response with the given filename.'
+          required: false
+          type: string
           allowEmptyValue: false
         - name: tqx
           in: query
           description: '[Google Visualization API](https://developers.google.com/chart/interactive/docs/dev/implementing_data_source?hl=en) formatted parameter.'
           required: false
           type: string
-          allowEmptyValue: false
       responses:
         '200':
           description: 'The call was successful. The response should include the data.'
@@ -204,4 +219,71 @@ definitions:
       name:
         type: string
         description: 'The name of the dimension'
-
+  
+  json_wrap:
+    type: object
+    properties:
+      api:
+        type: number
+        description: 'The API version this conforms to, currently 1'
+      id:
+        type: string
+        description: 'The unique id of the chart'
+      name:
+        type: string
+        description: 'The name of the chart'
+      update_every:
+        type: number
+        description: 'The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database (indepedently of the current view).'
+      view_update_every:
+        type: number
+        description: 'The current view appropriate update frequency of this chart, in seconds. There is no point to request chart refreshes, using the same settings, more frequently than this.'
+      first_entry:
+        type: number
+        description: 'The UNIX timestamp of the first entry (the oldest) in the round robin database (indepedently of the current view).'
+      last_entry:
+        type: number
+        description: 'The UNIX timestamp of the latest entry in the round robin database (indepedently of the current view).'
+      after:
+        type: number
+        description: 'The UNIX timestamp of the first entry (the oldest) returned in this response.'
+      before:
+        type: number
+        description: 'The UNIX timestamp of the latest entry returned in this response.'
+      min:
+        type: number
+        description: 'The minimum value returned in the current view. This can be used to size the y-series of the chart.'
+      max:
+        type: number
+        description: 'The maximum value returned in the current view. This can be used to size the y-series of the chart.'
+      dimension_names:
+        description: 'The dimension names of the chart as returned in the current view.'
+        type: array
+        items:
+          type: string
+      dimension_ids:
+        description: 'The dimension IDs of the chart as returned in the current view.'
+        type: array
+        items:
+          type: string
+      latest_values:
+        description: 'The latest values collected for the chart (indepedently of the current view).'
+        type: array
+        items:
+          type: string
+      view_latest_values:
+        description: 'The latest values returned with this response.'
+        type: array
+        items:
+          type: string
+      dimensions:
+        type: number
+        description: 'The number of dimensions returned.'
+      points:
+        type: number
+        description: 'The number of rows / points returned.'
+      format:
+        type: string
+        description: 'The format of the result returned.'
+      result:
+        description: 'The result requested, in the format requested.'