From ccfd7a2b2cd5e4e815b08d155fe76c670ebe4a8b Mon Sep 17 00:00:00 2001
From: Reinier Zwitserloot <reinier@zwitserloot.com>
Date: Fri, 28 Apr 2023 04:47:09 +0200
Subject: [PATCH] [apidoc] qoc indicator: Add the notion of 'index'

---
 schemas/Indicator.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/schemas/Indicator.yaml b/schemas/Indicator.yaml
index 456f079..cb0d687 100644
--- a/schemas/Indicator.yaml
+++ b/schemas/Indicator.yaml
@@ -16,6 +16,14 @@ properties:
     description: Short, in dutch, *HTML* (but rarely includes formatting; at most, sup/superscript).
     type: string
     example: Prevalentie Diabetes
+  index:
+    description: |-
+      *OPTIONAL* Indicators usually are based on documentation that tends to take the form of an
+      ordered list (like html `<ol>`), and it is convenient for indicators to copy this numbering scheme.
+      For most UI applications, simply prefix this to the title, e.g. render as `1. Title Here`.
+      If missing, do not show an index in the title.
+    type: number
+    example: 1
   xMin:
     description: Numeric value of the far left of the bar.
     type: number