[BACK-3970] Add spec for selectable TIDE report categories.

Author: lostlevels

Makefile

@@ -56,7 +56,8 @@ GO_TOOLS = \
 	$(TOOLS_BIN)/oapi-codegen
 
 $(TOOLS_BIN)/oapi-codegen: $(TOOLS_BIN)
-	GOBIN=$(shell pwd)/$(TOOLS_BIN) go install github.com/deepmap/oapi-codegen/cmd/[email protected]
+	GOBIN=$(shell pwd)/$(TOOLS_BIN) go install github.com/oapi-codegen/oapi-codegen/v2/cmd/[email protected]
+
 
 $(NPM_BIN)/%:
 	$(MAKE) install_npm_pkgs

reference/clinic.v1.yaml

@@ -253,22 +253,48 @@ paths:
           in: query
           name: period
           description: Time Period to display
+          required: true
         - schema:
             type: array
             items:
               type: string
-              format: '^[a-f0-9]{24}$'
+              pattern: '^[a-f0-9]{24}$'
+            minItems: 1
           in: query
           name: tags
           description: Comma-separated list of patient tag IDs
           style: form
           explode: false
+          required: true
         - schema:
             type: string
             format: date-time
           in: query
           name: lastDataCutoff
-          description: Inclusive
+          description: Inclusive minimum of date of last data from a patient.
+          required: true
+        - schema:
+            type: array
+            x-go-type-skip-optional-pointer: true
+            x-omitempty: true
+            x-omitzero: true
+            items:
+              type: string
+              enum: ['timeInVeryLowPercent', 'timeInAnyLowPercent', 'timeInExtremeHighPercent', 'timeInVeryHighPercent', 'timeInHighPercent', 'dropInTimeInTargetPercent', 'timeInTargetPercent', 'timeCGMUsePercent', 'meetingTargets', 'noData']
+          in: query
+          name: categories
+          description: Comma-separated list of TIDE report categories. If omitted or empty, the default TIDE categories will be returned.
+          style: form
+          explode: false
+        - schema:
+            type: boolean
+            x-go-type-skip-optional-pointer: true
+            x-omitempty: true
+            x-omitzero: true
+          in: query
+          name: excludeNoDataPatients
+          description: If true, then exclude / omit patients with no data in the TIDE report.
+          style: form
   '/v1/clinics/{clinicId}/patients':
     parameters:
       - $ref: '#/components/parameters/clinicId'

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

@@ -23,6 +23,10 @@ properties:
     description: Threshold used for determining if a value is very high
     type: number
     x-go-type: float64
+  extremeHighGlucoseThreshold:
+    description: Threshold used for determining if a value is extremely high
+    type: number
+    x-go-type: float64
   lowGlucoseThreshold:
     description: Threshold used for determining if a value is low
     type: number

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

@@ -1,31 +1,37 @@
 type: object
 title: tidefilters.v1
-description: ''
+description: 'Visual representation of filtered categories selected'
 properties:
-  timeInVeryLowPercent:
+  dropInTimeInTargetPercent:
+    type: string
+    pattern: ^(>=|>|<=|<)\d\.\d\d?$
+    example: '>0.5'
+  timeCGMUsePercent:
     type: string
     pattern: ^(>=|>|<=|<)\d\.\d\d?$
     example: '>0.5'
   timeInAnyLowPercent:
     type: string
     pattern: ^(>=|>|<=|<)\d\.\d\d?$
     example: '>0.5'
-  dropInTimeInTargetPercent:
+  timeInExtremeHighPercent:
+    type: string
+    pattern: ^(>=|>|<=|<)\d\.\d\d?$
+    example: '>0.5'
+  timeInHighPercent:
     type: string
     pattern: ^(>=|>|<=|<)\d\.\d\d?$
     example: '>0.5'
   timeInTargetPercent:
     type: string
     pattern: ^(>=|>|<=|<)\d\.\d\d?$
     example: '>0.5'
-  timeCGMUsePercent:
+  timeInVeryHighPercent:
+    type: string
+    pattern: ^(>=|>|<=|<)\d\.\d\d?$
+    example: '>0.5'
+  timeInVeryLowPercent:
     type: string
     pattern: ^(>=|>|<=|<)\d\.\d\d?$
     example: '>0.5'
 
-required:
-  - timeInVeryLowPercent
-  - timeInAnyLowPercent
-  - dropInTimeInTargetPercent
-  - timeInTargetPercent
-  - timeCGMUsePercent

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

@@ -1,14 +1,6 @@
 type: object
 title: tideresults.v1
 description: ''
-required:
-  - timeInVeryLowPercent
-  - timeInLowPercent
-  - dropInTimeInTargetPercent
-  - timeInTargetPercent
-  - timeCGMUsePercent
-  - meetingTargets
-  - noData
 additionalProperties:
   type: array
   items:

scripts/check_spec.sh

@@ -3,8 +3,13 @@
 set -euo pipefail
 
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-TOOLS_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../tools/bin")
-NPM_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../node_modules/.bin")
+if [[ $OSTYPE =~ darwin ]] && command -v grealpath &> /dev/null; then
+  TOOLS_BIN=$(grealpath --canonicalize-existing "$SCRIPT_DIR/../tools/bin")
+  NPM_BIN=$(grealpath --canonicalize-existing "$SCRIPT_DIR/../node_modules/.bin")
+else
+  TOOLS_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../tools/bin")
+  NPM_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../node_modules/.bin")
+fi
 PATH=$TOOLS_BIN:$NPM_BIN:$PATH
 
 trace() {

scripts/generate_clinic.sh

@@ -3,8 +3,13 @@
 set -eou pipefail
 
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
-TOOLS_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../tools/bin")
-NPM_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../node_modules/.bin")
+if [[ $OSTYPE =~ darwin ]] && command -v grealpath &> /dev/null; then
+  TOOLS_BIN=$(grealpath --canonicalize-existing "$SCRIPT_DIR/../tools/bin")
+  NPM_BIN=$(grealpath --canonicalize-existing "$SCRIPT_DIR/../node_modules/.bin")
+else
+  TOOLS_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../tools/bin")
+  NPM_BIN=$(realpath --canonicalize-existing "$SCRIPT_DIR/../node_modules/.bin")
+fi
 PATH=$TOOLS_BIN:$NPM_BIN:$PATH
 
 trace() {