diff options
-rw-r--r-- | api.md | 26 | ||||
-rw-r--r-- | readme.md | 6 |
2 files changed, 31 insertions, 1 deletions
@@ -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) @@ -1,6 +1,6 @@ # Jellything -Jellything (not to be confuse with "Jellyfin") is a media streaming software, +Jellything (not to be confused with "Jellyfin") is a media streaming software, optimizied for serving movies and such. ## Features @@ -12,3 +12,7 @@ optimizied for serving movies and such. ## Licence The Licence is AGPL-3.0-only, see `COPYING` + +## API + +See [`api.md`](./api.md) |