try to start summarizing the api

This commit is contained in:
Paul Trowbridge 2018-06-25 23:03:39 -04:00
parent 4c7acc8c81
commit 7353757900

8
plan/api.markdown Normal file
View File

@ -0,0 +1,8 @@
## /source
| end-point | method | body type | body | return |
| --------- | ------ | --------- | ----------- | ------------------------------------------ |
| source | GET | JSON | | source.json |
| source | POST | JSON | source.json | {"status":"ok/fail","message":"blah blah"} |
| regex | GET | JSON | | regex.json |
| regex | POST | JSON | regex.json | {"status":"ok/fail","message":"blah blah"} |