From 3ac75305dfa33429646bb5d415567034cccfeee3 Mon Sep 17 00:00:00 2001 From: Kelly Brazil Date: Tue, 12 Nov 2019 11:28:10 -0800 Subject: [PATCH] update process() doc --- docs/parsers/df.md | 10 +++++++++- docs/parsers/dig.md | 10 +++++++++- docs/parsers/env.md | 10 +++++++++- docs/parsers/free.md | 10 +++++++++- docs/parsers/history.md | 10 +++++++++- docs/parsers/ifconfig.md | 10 +++++++++- docs/parsers/iptables.md | 10 +++++++++- docs/parsers/jobs.md | 10 +++++++++- docs/parsers/ls.md | 10 +++++++++- docs/parsers/lsblk.md | 10 +++++++++- docs/parsers/lsmod.md | 10 +++++++++- docs/parsers/lsof.md | 10 +++++++++- docs/parsers/mount.md | 10 +++++++++- docs/parsers/netstat.md | 10 +++++++++- docs/parsers/ps.md | 10 +++++++++- docs/parsers/route.md | 10 +++++++++- docs/parsers/uname.md | 10 +++++++++- docs/parsers/uptime.md | 10 +++++++++- docs/parsers/w.md | 10 +++++++++- jc/parsers/df.py | 10 +++++++++- jc/parsers/dig.py | 10 +++++++++- jc/parsers/env.py | 10 +++++++++- jc/parsers/foo.py | 10 +++++++++- jc/parsers/free.py | 10 +++++++++- jc/parsers/history.py | 10 +++++++++- jc/parsers/ifconfig.py | 10 +++++++++- jc/parsers/iptables.py | 10 +++++++++- jc/parsers/jobs.py | 10 +++++++++- jc/parsers/ls.py | 10 +++++++++- jc/parsers/lsblk.py | 10 +++++++++- jc/parsers/lsmod.py | 10 +++++++++- jc/parsers/lsof.py | 10 +++++++++- jc/parsers/mount.py | 10 +++++++++- jc/parsers/netstat.py | 10 +++++++++- jc/parsers/ps.py | 10 +++++++++- jc/parsers/route.py | 10 +++++++++- jc/parsers/uname.py | 10 +++++++++- jc/parsers/uptime.py | 10 +++++++++- jc/parsers/w.py | 10 +++++++++- 39 files changed, 351 insertions(+), 39 deletions(-) diff --git a/docs/parsers/df.md b/docs/parsers/df.md index b6ddce6a..b65974a9 100644 --- a/docs/parsers/df.md +++ b/docs/parsers/df.md @@ -69,7 +69,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/dig.md b/docs/parsers/dig.md index c88ef298..2c5898ea 100644 --- a/docs/parsers/dig.md +++ b/docs/parsers/dig.md @@ -321,7 +321,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/env.md b/docs/parsers/env.md index ad922bf6..42ee6170 100644 --- a/docs/parsers/env.md +++ b/docs/parsers/env.md @@ -49,7 +49,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/free.md b/docs/parsers/free.md index 52c95205..cffa9a33 100644 --- a/docs/parsers/free.md +++ b/docs/parsers/free.md @@ -49,7 +49,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/history.md b/docs/parsers/history.md index 99951e41..ffdca2d4 100644 --- a/docs/parsers/history.md +++ b/docs/parsers/history.md @@ -41,7 +41,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/ifconfig.md b/docs/parsers/ifconfig.md index b9fa145e..6c201875 100644 --- a/docs/parsers/ifconfig.md +++ b/docs/parsers/ifconfig.md @@ -125,7 +125,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/iptables.md b/docs/parsers/iptables.md index 01932a53..c8faa693 100644 --- a/docs/parsers/iptables.md +++ b/docs/parsers/iptables.md @@ -131,7 +131,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/jobs.md b/docs/parsers/jobs.md index 625d7f86..ae6de833 100644 --- a/docs/parsers/jobs.md +++ b/docs/parsers/jobs.md @@ -73,7 +73,15 @@ Example: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { "job_number": integer, diff --git a/docs/parsers/ls.md b/docs/parsers/ls.md index 50efdc40..0c353420 100644 --- a/docs/parsers/ls.md +++ b/docs/parsers/ls.md @@ -140,7 +140,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/lsblk.md b/docs/parsers/lsblk.md index 67f51a54..39794dd1 100644 --- a/docs/parsers/lsblk.md +++ b/docs/parsers/lsblk.md @@ -212,7 +212,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/lsmod.md b/docs/parsers/lsmod.md index ec940521..c5e22a1d 100644 --- a/docs/parsers/lsmod.md +++ b/docs/parsers/lsmod.md @@ -103,7 +103,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/lsof.md b/docs/parsers/lsof.md index 56e76cbe..b60cf254 100644 --- a/docs/parsers/lsof.md +++ b/docs/parsers/lsof.md @@ -93,7 +93,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/mount.md b/docs/parsers/mount.md index bb6637b1..15b00314 100644 --- a/docs/parsers/mount.md +++ b/docs/parsers/mount.md @@ -53,7 +53,15 @@ Example: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/netstat.md b/docs/parsers/netstat.md index a2b49780..353174e0 100644 --- a/docs/parsers/netstat.md +++ b/docs/parsers/netstat.md @@ -309,7 +309,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/ps.md b/docs/parsers/ps.md index a5a5f246..1e7daea4 100644 --- a/docs/parsers/ps.md +++ b/docs/parsers/ps.md @@ -186,7 +186,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/route.md b/docs/parsers/route.md index dc20b172..3cd94391 100644 --- a/docs/parsers/route.md +++ b/docs/parsers/route.md @@ -97,7 +97,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/docs/parsers/uname.md b/docs/parsers/uname.md index 1efd244c..62c92ea6 100644 --- a/docs/parsers/uname.md +++ b/docs/parsers/uname.md @@ -26,7 +26,15 @@ Example: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: { "kernel_name": string, diff --git a/docs/parsers/uptime.md b/docs/parsers/uptime.md index 689e7bd3..301e9590 100644 --- a/docs/parsers/uptime.md +++ b/docs/parsers/uptime.md @@ -31,7 +31,15 @@ Example: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: { "time": string, diff --git a/docs/parsers/w.md b/docs/parsers/w.md index 2d1a43f0..8dd0776e 100644 --- a/docs/parsers/w.md +++ b/docs/parsers/w.md @@ -79,7 +79,15 @@ Examples: process(proc_data) ``` -schema: +Final processing to conform to the schema. + +Parameters: + + proc_data (dictionary) raw structured data to process + +Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/df.py b/jc/parsers/df.py index ee602eb1..f0ac6c6a 100644 --- a/jc/parsers/df.py +++ b/jc/parsers/df.py @@ -68,7 +68,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/dig.py b/jc/parsers/dig.py index 2a847202..a764d319 100644 --- a/jc/parsers/dig.py +++ b/jc/parsers/dig.py @@ -320,7 +320,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/env.py b/jc/parsers/env.py index deb66c15..775c01e4 100644 --- a/jc/parsers/env.py +++ b/jc/parsers/env.py @@ -48,7 +48,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/foo.py b/jc/parsers/foo.py index 399c70bc..42bb7fad 100644 --- a/jc/parsers/foo.py +++ b/jc/parsers/foo.py @@ -16,7 +16,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/free.py b/jc/parsers/free.py index 79a2bf05..bce35b53 100644 --- a/jc/parsers/free.py +++ b/jc/parsers/free.py @@ -48,7 +48,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/history.py b/jc/parsers/history.py index d3c227a8..8c489d6a 100644 --- a/jc/parsers/history.py +++ b/jc/parsers/history.py @@ -40,7 +40,15 @@ import jc def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/ifconfig.py b/jc/parsers/ifconfig.py index d2acd639..df06c03a 100644 --- a/jc/parsers/ifconfig.py +++ b/jc/parsers/ifconfig.py @@ -125,7 +125,15 @@ from ifconfigparser import IfconfigParser def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/iptables.py b/jc/parsers/iptables.py index bf638eab..6e50c3b1 100644 --- a/jc/parsers/iptables.py +++ b/jc/parsers/iptables.py @@ -130,7 +130,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/jobs.py b/jc/parsers/jobs.py index c05567f5..4c5f0ce4 100644 --- a/jc/parsers/jobs.py +++ b/jc/parsers/jobs.py @@ -73,7 +73,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { "job_number": integer, diff --git a/jc/parsers/ls.py b/jc/parsers/ls.py index dad1e9b6..97f6c51d 100644 --- a/jc/parsers/ls.py +++ b/jc/parsers/ls.py @@ -140,7 +140,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/lsblk.py b/jc/parsers/lsblk.py index c7eeb650..a0a8b6be 100644 --- a/jc/parsers/lsblk.py +++ b/jc/parsers/lsblk.py @@ -212,7 +212,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/lsmod.py b/jc/parsers/lsmod.py index 1f5d9b12..4cbd90c7 100644 --- a/jc/parsers/lsmod.py +++ b/jc/parsers/lsmod.py @@ -102,7 +102,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/lsof.py b/jc/parsers/lsof.py index d792fffa..50e489a5 100644 --- a/jc/parsers/lsof.py +++ b/jc/parsers/lsof.py @@ -93,7 +93,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/mount.py b/jc/parsers/mount.py index e2138bc0..c9f7681a 100644 --- a/jc/parsers/mount.py +++ b/jc/parsers/mount.py @@ -52,7 +52,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/netstat.py b/jc/parsers/netstat.py index c1e2a9eb..a9eacc94 100644 --- a/jc/parsers/netstat.py +++ b/jc/parsers/netstat.py @@ -309,7 +309,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/ps.py b/jc/parsers/ps.py index 8a64c405..98bce919 100644 --- a/jc/parsers/ps.py +++ b/jc/parsers/ps.py @@ -185,7 +185,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/route.py b/jc/parsers/route.py index 22afcd84..6859a839 100644 --- a/jc/parsers/route.py +++ b/jc/parsers/route.py @@ -96,7 +96,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ { diff --git a/jc/parsers/uname.py b/jc/parsers/uname.py index f08cb78c..4602a84a 100644 --- a/jc/parsers/uname.py +++ b/jc/parsers/uname.py @@ -25,7 +25,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: { "kernel_name": string, diff --git a/jc/parsers/uptime.py b/jc/parsers/uptime.py index bfde9f4f..3dbd09eb 100644 --- a/jc/parsers/uptime.py +++ b/jc/parsers/uptime.py @@ -30,7 +30,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: { "time": string, diff --git a/jc/parsers/w.py b/jc/parsers/w.py index 3c37efc0..4cadf51a 100644 --- a/jc/parsers/w.py +++ b/jc/parsers/w.py @@ -79,7 +79,15 @@ import jc.utils def process(proc_data): """ - schema: + Final processing to conform to the schema. + + Parameters: + + proc_data (dictionary) raw structured data to process + + Returns: + + dictionary structured data with the following schema: [ {