api doc

1 files changed, 26 insertions, 0 deletions

diff --git a/api.md b/api.md
new file mode 100644
index 0000000..a8a229e
--- /dev/null
+++ b/api.md
@@ -0,0 +1,26 @@
+# Jellything API
+
+Routes marked with `*` require authentification. Any endpoint returning JSON,
+will report errors with an object containing error string in the `error` key.
+
+The `jellycommon` crate provides useful structs for deserializing data.
+
+```toml
+# Cargo.toml
+[depedencies]
+jellycommon = { git = "https://codeberg.org/metamuffin/jellything.git" }
+```
+
+## GET `/api/version`
+
+Returns API version number.
+
+## POST `/api/account/login`
+
+Request body contains JSON with keys `username` and `password`. The Response
+contains the session cookie.
+
+## GET* `/api/library/<path...>`
+
+Request a library node (either a directory or item). See
+[`common/src/api.rs`](./common/src/api.rs)