iamthefij/email-assistant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update 'parsers/Readme.md'

Browse Source 
Update Readme to fix table formatting
This commit is contained in:
IamTheFij 2018-02-02 19:30:53 +00:00
parent 05182a65fe
commit 0529de1723
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
parsers/Readme.md
View File

@ -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|