summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarpenter, Adam (CORP) <Adam.Carpenter@adp.com>2021-10-12 15:25:50 -0400
committerCarpenter, Adam (CORP) <Adam.Carpenter@adp.com>2021-10-12 15:25:50 -0400
commita821b8dcd3db131376b960deaacd33687916bc36 (patch)
treee09fd25bdbc2a085d2ff6119e5d519c59c6aae2c
parentc92c389b20a679e9c3c72db9a39e1aa44b01091a (diff)
downloadaltruistic-angelshark-a821b8dcd3db131376b960deaacd33687916bc36.tar.xz
altruistic-angelshark-a821b8dcd3db131376b960deaacd33687916bc36.zip
docs: example get version
-rw-r--r--angelsharkd/README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/angelsharkd/README.md b/angelsharkd/README.md
index 9e0942a..405a039 100644
--- a/angelsharkd/README.md
+++ b/angelsharkd/README.md
@@ -6,7 +6,18 @@ available endpoints.
## `GET /` Current Running Version
-TODO:
+Returns the current running version of Angelshark.
+
+```
+GET /
+```
+
+```json
+200 OK
+{
+ "daemon_version": "0.1.0"
+}
+```
## `POST /ossi` Run OSSI Command(s)