From 735375790027f0ba3eba23bc77cf86635feadc39 Mon Sep 17 00:00:00 2001 From: Paul Trowbridge Date: Mon, 25 Jun 2018 23:03:39 -0400 Subject: [PATCH] try to start summarizing the api --- plan/api.markdown | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 plan/api.markdown diff --git a/plan/api.markdown b/plan/api.markdown new file mode 100644 index 0000000..d87477c --- /dev/null +++ b/plan/api.markdown @@ -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"} | \ No newline at end of file