From 141cf654cea128c3c00c6d32dbc1bdeeb40b79b3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ensar=20Saraj=C4=8Di=C4=87?= <esarajcic1@etf.unsa.ba>
Date: Tue, 30 Oct 2018 20:55:35 +0100
Subject: [PATCH] Add missing docs for recording query

---
 .../create_device_recording_query_spec.yaml   | 20 +++++++++++++++++++
 app/swagger/template.yaml                     | 20 +++++++++++++++++++
 2 files changed, 40 insertions(+)
 create mode 100644 app/api/resources/swagger/create_device_recording_query_spec.yaml

diff --git a/app/api/resources/swagger/create_device_recording_query_spec.yaml b/app/api/resources/swagger/create_device_recording_query_spec.yaml
new file mode 100644
index 0000000..74b3e36
--- /dev/null
+++ b/app/api/resources/swagger/create_device_recording_query_spec.yaml
@@ -0,0 +1,20 @@
+Creates new recording query
+---
+tags:
+  - Recording
+parameters:
+  - in: path
+    name: device_id
+    required: true
+    type: integer
+    description: Id of the device
+  - in: body
+    name: body
+    required: true
+    schema:
+      $ref: '#/definitions/Query'
+responses:
+  200:
+    description: Success
+    schema:
+      type: array
diff --git a/app/swagger/template.yaml b/app/swagger/template.yaml
index b02253a..02d02d2 100644
--- a/app/swagger/template.yaml
+++ b/app/swagger/template.yaml
@@ -161,6 +161,26 @@ definitions:
         description: Value of the recording
         example: 25.0
 
+  Query:
+    type: object
+    required:
+      - selections
+      - filters
+      - groups
+    properties:
+      selections:
+        type: object
+        description: SELECT part of query - columns to select and aggregate
+        example: { "record_value": "sum" }
+      filters:
+        type: object
+        description: WHERE part of query (filters) - All of them are combined with AND
+        example: { "record_value": { "$gt": "300", "$lt": "1000" } }
+      groups:
+        type: object
+        description: GROUP BY part of query
+        example: { "recorded_at": "year" }
+
   RecordingCreation:
     type: object
     required: