Add support for footnote in prefix description. (#20)

README.md

@@ -62,9 +62,7 @@ These are fields which are common across all types of events.
 
 ## <a name="agent"></a> Agent fields
 
-The agent fields contains the data about the agent/client/shipper that created the event.
-
-As an example in case of Beats for logs the `agent.name` is `filebeat`. In the case of APM it is the agent running in the app / service. The agent information does not change if data is sent through queuing system like Kafka, Redis, or processing systems like Logstash or APM Server.
+The agent fields contain the data about the agent/client/shipper that created the event.
 
 
 | Field  | Description  | Type  | Multi Field  | Example  |
@@ -75,6 +73,9 @@ As an example in case of Beats for logs the `agent.name` is `filebeat`. In the c
 | <a name="agent.ephemeral_id"></a>`agent.ephemeral_id`  | Ephemeral identifier of this agent if one exists.<br/>This id compared to id normally changes across restarts.  | keyword  |   | `8a4f500f`  |
 
 
+In the case of Beats for logs, the agent.name is filebeat. For APM, it is the agent running in the app/service. The agent information does not change if data is sent through queuing systems like Kafka, Redis, or processing systems such as Logstash or APM Server.
+
+
 ## <a name="cloud"></a> Cloud fields
 
 All fields related to the cloud or infrastructure the events are coming from.

schemas/agent.yml

@@ -3,13 +3,13 @@
   title: Agent
   group: 2
   description: >
-    The agent fields contains the data about the agent/client/shipper that
+    The agent fields contain the data about the agent/client/shipper that
     created the event.
-
-    As an example in case of Beats for logs the `agent.name` is `filebeat`.
-    In the case of APM it is the agent running in the app / service. The agent
-    information does not change if data is sent through queuing system like
-    Kafka, Redis, or processing systems like Logstash or APM Server.
+  footnote: >
+    In the case of Beats for logs, the agent.name is filebeat. For APM, it is the
+    agent running in the app/service. The agent information does not change if
+    data is sent through queuing systems like Kafka, Redis, or processing systems
+    such as Logstash or APM Server.
   fields:
     - name: version
       type: keyword

scripts/helper.py

@@ -35,6 +35,7 @@ def clean_fields(fields):
 
         for field in namespace["fields"]:
             clean_string_field(field, "description")
+            clean_string_field(field, "footnote")
             clean_string_field(field, "example")
             clean_string_field(field, "type")
 
@@ -136,4 +137,7 @@ def get_markdown_table(namespace, title_prefix="##", link=False):
 
     output += "\n\n"
 
+    if "footnote" in namespace:
+        output += namespace["footnote"].replace("\n", "\n\n") + "\n"
+
     return output