From 0529de1723f669061764a2aeaa345983a18d68f2 Mon Sep 17 00:00:00 2001 From: IamTheFij Date: Fri, 2 Feb 2018 19:30:53 +0000 Subject: [PATCH] Update 'parsers/Readme.md' Update Readme to fix table formatting --- parsers/Readme.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/parsers/Readme.md b/parsers/Readme.md index b436dd6..3e5a11d 100644 --- a/parsers/Readme.md +++ b/parsers/Readme.md @@ -4,19 +4,32 @@ A parser should conform to a simple API spec so that it can be easily accessed # Healthcheck Simple endpoint that accepts nothing and returns 'OK' on success. + +|Attrs | | +|--------|---| |Path |`/`| |Method |`GET`| |Response|`"OK"`| - # Parse The primary endpoint that will parse a message + +|Attrs | | +|--------|---| |Path |`/parse`| |Method |`POST`| +|Request |`json`| |Response|`json`| -Response -|Key |Example Value |Description| -|--------|----------------------|-----------| -|token |`"1Z879E930346834440"`|String token that was extracted| -|type |`"SHIPPING"` |A string that indicates what type of metadata that was extracted. This will be used by other services to understand what kind of data this is.| -|metadata|`{"carrier": "UPS"}` |A dictionary with any other additional metadat that may be used by other services| +Request: + +|Key |Example Value |Description| +|--------|-----------------------------------------------------|-----------| +|`"message"` |`"Here's your tracking number: 1Z879E930346834440"`|Full contents of the email message| + +Response: + +|Key |Example Value |Description| +|------------|----------------------|-----------| +|`"token"` |`"1Z879E930346834440"`|String token that was extracted| +|`"type"` |`"SHIPPING"` |A string that indicates what type of metadata that was extracted. This will be used by other services to understand what kind of data this is.| +|`"metadata"`|`{"carrier": "UPS"}` |A dictionary with any other additional metadat that may be used by other services|