From 87ebdede17007b626b1275c66dde1e5aefd6cddc Mon Sep 17 00:00:00 2001 From: metamuffin Date: Thu, 6 Feb 2025 16:52:32 +0100 Subject: update book --- doc/api.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) (limited to 'doc/api.md') diff --git a/doc/api.md b/doc/api.md index 8eedca0..63ed274 100644 --- a/doc/api.md +++ b/doc/api.md @@ -12,7 +12,7 @@ those used in the library and for jhls. - [jellytranscode](/doc/jellytranscode/) - [jellyimport](/doc/jellyimport/) - [jellymatroska](/doc/jellymatroska/) - - [ebml_derive](/doc/ebml_derive/) + - [ebml_derive](/doc/ebml_derive/) - [jellybase](/doc/jellybase/) - [jellystream](/doc/jellystream/) - [jellytool](/doc/jellytool/) @@ -46,13 +46,27 @@ 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/` +### GET* `/n/?&&` -Request a library node (either a directory or item). Returns it as `NodePublic`. +Request a library node with userdata attached. If `parents` or `children` flag +is set, all parents/children will be returned too, otherwise those lists are +empty. Returns `ApiNodeResponse`. -### GET* `/n//extended` +### GET* `/n//userdata` -Request extended informationf for library node. Returns it as `ExtendedNode`. +Returns only `NodeUserData` for that node. + +### GET* `/search?&` + +Returns `ApiSearchResponse`. + +### GET* `/items?&` + +Returns `ApiItemsResponse`. + +### GET* `/home` + +Returns `ApiHomeResponse`. ## Assets @@ -61,11 +75,11 @@ coded with AVIF. The `width` parameter is the width of the resolution you want to image to be. > [!WARNING] The actual returned resolution must not be exactly what you -> requested. +> requested. Currently it is rounded up to the next power of two. -### GET* `/n//asset?&` +### GET* `/n//poster?` -Where `role` is one of `backdrop` or `poster` and +### GET* `/n//backdrop?` ### GET* `/n//thumbnail?&` -- cgit v1.2.3-70-g09d2