From e12af64d7579299b33b5699e0ace0678330a3b96 Mon Sep 17 00:00:00 2001
From: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Date: Tue, 21 May 2019 11:31:49 +0200
Subject: Update swagger with definition of api/v1/alarm_variables (#6055)

---
 web/api/netdata-swagger.json | 97 ++++++++++++++++++++++++++++++++++++++++++++
 web/api/netdata-swagger.yaml | 67 ++++++++++++++++++++++++++++++
 2 files changed, 164 insertions(+)

(limited to 'web/api')

diff --git a/web/api/netdata-swagger.json b/web/api/netdata-swagger.json
index 2fa55c4faa..6d28e840a2 100644
--- a/web/api/netdata-swagger.json
+++ b/web/api/netdata-swagger.json
@@ -77,6 +77,39 @@
         }
       }
     },
+    "/alarm_variables": {
+      "get": {
+        "summary": "List variables available to configure alarms for a chart",
+        "description": "Returns the basic information of a chart and all the variables that can be used in alarm and template health configurations for the particular chart or family",
+        "parameters": [
+          {
+            "name": "chart",
+            "in": "query",
+            "description": "The id of the chart as returned by the /charts call.",
+            "required": true,
+            "type": "string",
+            "format": "as returned by /charts"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A javascript object with information about the chart and the available variables",
+            "schema": {
+              "$ref": "#/definitions/alarm_variables"
+            }
+          },
+          "400": {
+            "description": "Bad request - the body will include a message stating what is wrong."
+          },
+          "404": {
+            "description": "No chart with the given id is found."
+          },
+          "500": {
+            "description": "Internal server error. This usually means the server is out of memory."
+          }
+        }
+      }
+    },
     "/data": {
       "get": {
         "summary": "Get collected data for a specific chart",
@@ -951,6 +984,70 @@
         }
       }
     },
+    "alarm_variables": {
+      "type": "object",
+      "properties": {
+        "chart": {
+          "type": "string",
+          "description": "The unique id of the chart"
+        },
+        "chart_name": {
+          "type": "string",
+          "description": "The name of the chart"
+        },
+        "cnart_context": {
+          "type": "string",
+          "description": "The context of the chart. It is shared across multiple monitored software or hardware instances and used in alarm templates"
+        },
+        "family": {
+          "type": "string",
+          "description": "The family of the chart."
+        },
+        "host": {
+          "type": "string",
+          "description": "The host containing the chart."
+        },
+        "chart_variables": {
+          "type": "object",
+          "properties": {
+            "varname1": {
+              "type": "number",
+              "format": "float"
+            },
+            "varname2": {
+              "type": "number",
+              "format": "float"
+            }
+          }
+        },
+        "family_variables": {
+          "type": "object",
+          "properties": {
+            "varname1": {
+              "type": "number",
+              "format": "float"
+            },
+            "varname2": {
+              "type": "number",
+              "format": "float"
+            }
+          }
+        },
+        "host_variables": {
+          "type": "object",
+          "properties": {
+            "varname1": {
+              "type": "number",
+              "format": "float"
+            },
+            "varname2": {
+              "type": "number",
+              "format": "float"
+            }
+          }
+        }
+      }
+    },
     "dimension": {
       "type": "object",
       "properties": {
diff --git a/web/api/netdata-swagger.yaml b/web/api/netdata-swagger.yaml
index c021efefa7..9c5517d03a 100644
--- a/web/api/netdata-swagger.yaml
+++ b/web/api/netdata-swagger.yaml
@@ -63,6 +63,28 @@ paths:
             $ref: '#/definitions/chart'
         '404':
           description: 'No chart with the given id is found.'
+  /alarm_variables:
+    get:
+      summary: 'List variables available to configure alarms for a chart'
+      description: 'Returns the basic information of a chart and all the variables that can be used in alarm and template health configurations for the particular chart or family'
+      parameters:
+        - name: chart
+          in: query
+          description: 'The id of the chart as returned by the /charts call.'
+          required: true
+          type: string
+          format: 'as returned by /charts'
+      responses:
+        '200':
+            description: 'A javascript object with information about the chart and the available variables'
+            schema:
+              $ref: '#/definitions/alarm_variables'
+        '400':
+          description: 'Bad request - the body will include a message stating what is wrong.'
+        '404':
+          description: 'No chart with the given id is found.'
+        '500':
+          description: 'Internal server error. This usually means the server is out of memory.'
   /data:
     get:
       summary: 'Get collected data for a specific chart'
@@ -638,6 +660,51 @@ definitions:
       red:
         type: number
         description: 'Chart health red trheshold'
+  alarm_variables:
+    type: object
+    properties:
+      chart:
+        type: string
+        description: 'The unique id of the chart'
+      chart_name:
+        type: string
+        description: 'The name of the chart'
+      cnart_context:
+        type: string
+        description: 'The context of the chart. It is shared across multiple monitored software or hardware instances and used in alarm templates'
+      family:
+        type: string
+        description: 'The family of the chart.'
+      host:
+        type: string
+        description: 'The host containing the chart.'
+      chart_variables:
+        type: object
+        properties:
+          varname1:
+            type: number
+            format: float
+          varname2:
+            type: number
+            format: float
+      family_variables:
+        type: object
+        properties:
+          varname1:
+            type: number
+            format: float
+          varname2:
+            type: number
+            format: float
+      host_variables:
+        type: object
+        properties:
+          varname1:
+            type: number
+            format: float
+          varname2:
+            type: number
+            format: float
   dimension:
     type: object
     properties:
-- 
cgit v1.2.3