[apidoc] Added a (work in progress) example JSON response for an indicator set

examples/qoc_indicatorset.1.json

@@ -0,0 +1,125 @@
+{
+  "key": "ZOO-dm",
+  "name": "Diabetes Mellitus type 2",
+  "refDate": "2023-07-01",
+  "chapters": [
+    {
+      "title": "Opbouw DM ketenzorg patiënten",
+      "indicators": [
+        [
+          {
+            "key": "ZOO-dm-prevalentie-1",
+            "title": "Prevalentie DM",
+            "index": 1,
+            "xMin": 0,
+            "xMax": 10.5,
+            "xLow": {
+              "pos": 2.0,
+              "legend": "2.0%"
+            },
+            "xHigh": {
+              "pos": 8.2,
+              "legend": "8.2%"
+            },
+            "style": "met",
+            "bars": [
+              {
+                "legend": "Praktijk 2023Q3",
+                "value": 2818,
+                "parts": [
+                  {
+                    "style": "concern",
+                    "width": 9.297374,
+                    "value": 262
+                  }
+                ]
+              },
+              {
+                "legend": "ZEL 2023Q3",
+                "value": 325123,
+                "parts": [
+                  {
+                    "style": "good",
+                    "width": 4.919984,
+                    "value": 15996
+                  }
+                ]
+              }
+            ]
+          }
+        ],
+        [
+          {
+            "key": "ZOO-dm-prevalentie$-1",
+            "title": "DM types",
+            "basedOn": "ZOO-dm-prevalentie-1",
+            "index": 2,
+            "xMin": 0,
+            "xMax": 100,
+            "style": "normal",
+            "legend": {
+              "cat1": "T1",
+              "cat2": "T2",
+              "problem1": "Beide",
+              "problem2": "Onbekend"
+            },
+            "bars": [
+              {
+                "legend": "Praktijk 2023Q3",
+                "value": 262,
+                "parts": [
+                  {
+                    "style": "cat1",
+                    "width": 11.068702,
+                    "value": 29
+                  },
+                  {
+                    "style": "cat2",
+                    "width": 86.64122137,
+                    "value": 227
+                  },
+                  {
+                    "style": "problem1",
+                    "width": 2.29007634,
+                    "value": 6
+                  },
+                  {
+                    "style": "problem2",
+                    "width": 0,
+                    "value": 0
+                  }
+                ]
+              },
+              {
+                "legend": "ZEL 2023Q3",
+                "value": 15996,
+                "parts": [
+                  {
+                    "style": "cat1",
+                    "width": 9.00225056,
+                    "value": 1440
+                  },
+                  {
+                    "style": "cat2",
+                    "width": 86.996749,
+                    "value": 13916,
+                  },
+                  {
+                    "style": "problem1",
+                    "width": 2.313078,
+                    "value" 370
+                  },
+                  {
+                    "style": "problem2",
+                    "width": 1.68792198,
+                    "value": 270
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      ]
+    }
+  ]
+}

schemas/Indicator.yaml

@@ -94,5 +94,5 @@ properties:
         value:
           description: |-
             The 'size' of the described ratio. Relative to the range of the bar (as described by `xMax`-`xMin`).
-            type: number
-            example: 20.5
+          type: number
+          example: 20.5