From 7ded0f89080275d9a59e5155e1459ad7bf28509b Mon Sep 17 00:00:00 2001 From: metamuffin Date: Thu, 25 Jan 2024 19:04:29 +0100 Subject: more doc + api --- api.md | 41 ----------------------------------------- 1 file changed, 41 deletions(-) delete mode 100644 api.md (limited to 'api.md') diff --git a/api.md b/api.md deleted file mode 100644 index 1b78a41..0000000 --- a/api.md +++ /dev/null @@ -1,41 +0,0 @@ -# Jellything API - -Most endpoints require the `Accept` header to be present and set to -`application/json`. Any endpoint returning JSON, will report errors with an -object containing error string in the `error` key. Routes marked with `*` -require authentification. - -The `jellyclient` crate already implements most API functionality. The -`jellycommon` crate provides useful structs for deserializing data (also -reexported in jellyclient). - -```toml -# Cargo.toml -[depedencies] -jellyclient = { git = "https://codeberg.org/metamuffin/jellything.git" } -``` - -## GET `/api/version` - -Returns API version number. - -## POST `/api/create_session` - -Request body contains JSON with keys `username`, `password`, `expire` (in -seconds) and `drop_permissions` (a list of permissions, that this session cannot -use). The Response contains the session cookie as a string in JSON. - -## GET* `/n/` - -Request a library node (either a directory or item). Returns it as `NodePublic`. - -## GET* `/n//asset?&` - -Where `role` is one of `backdrop` or `poster` and `width` is the width of the -resolution you want to image to be in. The actual returned resolution must not -be exactly what you requested. Returns assets for a node. - -## GET* `/stream/?&&&&&` - -Responds with the stream directly or a redirect to the actual source in case of -federation. -- cgit v1.2.3-70-g09d2