From a855344bec9f60d852de326953436ec76f25cffb Mon Sep 17 00:00:00 2001
From: Kelly Brazil <kellyjonbrazil@gmail.com>
Date: Mon, 4 Nov 2019 13:05:56 -0800
Subject: [PATCH] document schema

---
 jc/parsers/arp.py | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/jc/parsers/arp.py b/jc/parsers/arp.py
index a00674ed..8b3328df 100644
--- a/jc/parsers/arp.py
+++ b/jc/parsers/arp.py
@@ -80,6 +80,19 @@ $ arp -a | jc --arp -p -r
 
 
 def process(proc_data):
+    '''schema:
+    [
+      {
+        "name":       string,
+        "address":    string,
+        "hwtype":     string,
+        "hwaddress":  string,
+        "flags_mask": string,
+        "iface":      string
+      }
+    ]
+    '''
+
     # in BSD style, change name to null if it is a question mark
     for entry in proc_data:
         if 'name' in entry and entry['name'] == '?':