Skip to content

Commit

Permalink
DOC: Add example monitor message schema to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cortadocodes committed Nov 24, 2021
1 parent 7f39a84 commit 980f35f
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions docs/source/anatomy_monitors.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
.. _monitors_strand:

===============
Monitors Strand
===============
======================
Monitor Message Strand
======================

The ``configuration_values_schema``, ``input_values_schema`` and ``output_values_schema`` strands are *values-based*,
meaning the data that matches these strands is in JSON form.

Each of these strands is a *json schema* which describes that data.
The ``monitor_message_schema`` strand is *values-based* meaning the data that matches the strand is in JSON form. It is
a *json schema* which describes a monitor message.

.. tabs::

Expand Down Expand Up @@ -40,5 +38,18 @@ Let's look at basic examples for twines containing each of these strands:

**Monitor data (output)**

**Log data (output)**
.. code-block:: javascript
{
"monitor_message_schema": {
"type": "object",
"properties": {
"my_property": {
"type": "number"
}
},
"required": ["my_property"]
}
}
**Log data (output)**

0 comments on commit 980f35f

Please sign in to comment.