Remove tide filters from response and replace w/ categories as all filters are just categories.

Author: lostlevels

reference/clinic.v1.yaml

@@ -270,9 +270,13 @@ paths:
           name: lastDataCutoff
           description: Inclusive
         - schema:
-            type: array
-            items:
-              $ref: ./clinic/models/tide/tideCategoryName.v1.yaml
+            oneOf:
+              - type: array
+                items:
+                  $ref: '#/components/schemas/predefinedCategoryName.v1'
+              - type: array
+                items:
+                  type: string
           in: query
           name: categories
           description: Comma-separated list of category names to include in the report. Omit to include all.
@@ -2539,6 +2543,17 @@ components:
           description: Optional action to be performed when a unique match has been found
       required:
         - criteria
+    predefinedCategoryName.v1:
+      type: string
+      enum:
+        - timeInVeryLowPercent
+        - timeInAnyLowPercent
+        - dropInTimeInTargetPercent
+        - timeInTargetPercent
+        - timeCGMUsePercent
+        - meetingTargets
+        - noData
+      description: Existing default pre-defined TIDE report categories.
   securitySchemes:
     sessionToken:
       name: x-tidepool-session-token

reference/clinic/models/tide/tideCategory.v1.yaml

@@ -1,22 +1,43 @@
 type: object
 title: tidecategory.v1
 properties:
-  heading:
+  name:
     description: Name of the category.
     type: string
-  field:
-    description: The target field to compare against. It is one of the two operands to the comparison operator.
-    type: string
-  value:
-    description: The reference value to compare the field against.
-    type: number
-    x-go-type: float64
   comparison:
-    description: The comparison operator to make between the field's value and the category's reference value, with field being the first operand and value being the second. `field comparison value`
-    type: string
-    enum: ['>', '>=', '<', '<=', '=']
+    description: Describes a comparison filter against a summary field.
+    type: object
+    properties:
+      summaryField:
+        description: Summary field to compare against.
+        $ref: './tideSummaryField.v1.yaml'
+      op:
+        description: Comparison operator.
+        type: string
+        enum: ['>', '>=', '<', '<=', '=']
+      value:
+        description: Value to compare summaryField against.
+    required:
+      - summaryField
+      - op
+      - value
+  sort:
+    description: Describes a sorting operation against a summary field.
+    type: object
+    properties:
+      summaryField:
+        description: Summary field to use as a sort key.
+        $ref: './tideSummaryField.v1.yaml'
+      direction:
+        description: Sort direction.
+        type: string
+        enum: ['ascending', 'descending']
+    required:
+      - summaryField
+      - direction
+  priority:
+    description: Priority of category to use when iterating against a list of categories when generating a TIDE report with a lower value having higher priority. This is used to because of a TIDE report patient limit so higher priority categories will be queried first.
+    type: integer
 required:
-  - heading
-  - comparison
-  - field
-  - value
+  - name
+  - sort

reference/clinic/models/tide/tideCategoryName.v1.yaml

@@ -33,8 +33,11 @@ properties:
     x-go-type: float64
   tags:
     $ref: ../patientTagIds.v1.yaml
-  filters:
-    $ref: ./tideFilters.v1.yaml
+  categories:
+    description: Categories that were used during report generation.
+    type: array
+    items:
+      $ref: ./tideCategory.v1.yaml
 
 required:
   - schemaVersion
@@ -46,4 +49,3 @@ required:
   - lowGlucoseThreshold
   - veryLowGlucoseThreshold
   - tags
-  - filters

reference/clinic/models/tide/tideConfig.v1.yaml

@@ -8,7 +8,7 @@ properties:
       $ref: ./tideCategory.v1.yaml
   thresholds:
     $ref: ./tideThresholds.v1.yaml
-    description: Thresholds for values to be considered low / high. Read-only as the values are hardcoded in the summary service.
+    description: Thresholds for values to be considered low / high. Read-only as the values are hardcoded in the platform summary service.
 required:
   - categories
   - thresholds

reference/clinic/models/tide/tideSettings.v1.yaml

@@ -0,0 +1,73 @@
+title: tidesummaryfield.v1.yaml
+description: Available summary fields for a TIDE report category to filter / sort against.
+type: string
+enum:
+  - averageDailyRecords
+  - averageDailyRecordsDelta
+  - averageGlucoseMmol
+  - averageGlucoseMmolDelta
+  - coefficientOfVariation
+  - coefficientOfVariationDelta
+  - daysWithData
+  - daysWithDataDelta
+  - hoursWithData
+  - hoursWithDataDelta
+  - standardDeviation
+  - standardDeviationDelta
+  - timeCGMUseMinutes
+  - timeCGMUseMinutesDelta
+  - timeCGMUsePercent
+  - timeCGMUsePercentDelta
+  - timeCGMUseRecords
+  - timeCGMUseRecordsDelta
+  - timeInAnyHighMinutes
+  - timeInAnyHighMinutesDelta
+  - timeInAnyHighPercent
+  - timeInAnyHighPercentDelta
+  - timeInAnyHighRecords
+  - timeInAnyHighRecordsDelta
+  - timeInAnyLowMinutes
+  - timeInAnyLowMinutesDelta
+  - timeInAnyLowPercent
+  - timeInAnyLowPercentDelta
+  - timeInAnyLowRecords
+  - timeInAnyLowRecordsDelta
+  - timeInExtremeHighMinutes
+  - timeInExtremeHighMinutesDelta
+  - timeInExtremeHighPercent
+  - timeInExtremeHighPercentDelta
+  - timeInExtremeHighRecords
+  - timeInExtremeHighRecordsDelta
+  - timeInHighMinutes
+  - timeInHighMinutesDelta
+  - timeInHighPercent
+  - timeInHighPercentDelta
+  - timeInHighRecords
+  - timeInHighRecordsDelta
+  - timeInLowMinutes
+  - timeInLowMinutesDelta
+  - timeInLowPercent
+  - timeInLowPercentDelta
+  - timeInLowRecords
+  - timeInLowRecordsDelta
+  - timeInTargetMinutes
+  - timeInTargetMinutesDelta
+  - timeInTargetPercent
+  - timeInTargetPercentDelta
+  - timeInTargetRecords
+  - timeInTargetRecordsDelta
+  - timeInVeryHighMinutes
+  - timeInVeryHighMinutesDelta
+  - timeInVeryHighPercent
+  - timeInVeryHighPercentDelta
+  - timeInVeryHighRecords
+  - timeInVeryHighRecordsDelta
+  - timeInVeryLowMinutes
+  - timeInVeryLowMinutesDelta
+  - timeInVeryLowPercent
+  - timeInVeryLowPercentDelta
+  - timeInVeryLowRecords
+  - timeInVeryLowRecordsDelta
+  - totalRecords
+  - totalRecordsDelta
+