add docs and defensive check for bool #105

Author: donaldcampbelljr

docs/pipestat_specification.md

@@ -196,6 +196,24 @@ log_file:
 
 The highlighted results can be later retrieved by pipestat clients via `PipestatManager.highlighted_results` property, which simply returns a list of result identifiers.
 
+## Add indexing to a Result (database backend only)
+If you would like to index a specific result, you can add `index: True` to the result:
+
+```yaml
+title: An example Pipestat output schema
+description: A pipeline that uses pipestat to report sample and project level results.
+type: object
+properties:
+  pipeline_name: "default_pipeline_name"
+  samples:
+    type: object
+    properties:
+      number_of_things:
+        type: integer
+        description: "Number of things"
+        index: True
+```
+
 # Status schema
 
 Apart from results reporting pipestat provides a robust pipeline status management system, which can be used to report pipeline status from within the pipeline and monitor pipeline's status in other software. Status schema file defines the possible pipeline status identifiers and provides other metadata, like `description` or `color` for display purposes.

pipestat/backends/db_backend/db_parsed_schema.py

@@ -174,7 +174,8 @@ def _make_field_definitions(self, data: Dict[str, Any], require_type: bool):
                 )
             else:
                 if "index" in subdata:
-                    result_indexed = subdata["index"]
+                    if isinstance(subdata["index"], bool):
+                        result_indexed = subdata["index"]
                 defs[name] = (
                     data_type,
                     Field(