diff options
Diffstat (limited to 'doc/api.md')
| -rw-r--r-- | doc/api.md | 30 |
1 files changed, 22 insertions, 8 deletions
@@ -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/<id>` +### GET* `/n/<id>?<parents>&<children>&<filter..>` -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/<id>/extended` +### GET* `/n/<id>/userdata` -Request extended informationf for library node. Returns it as `ExtendedNode`. +Returns only `NodeUserData` for that node. + +### GET* `/search?<query>&<page>` + +Returns `ApiSearchResponse`. + +### GET* `/items?<filter..>&<page>` + +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/<id>/asset?<role>&<width>` +### GET* `/n/<id>/poster?<width>` -Where `role` is one of `backdrop` or `poster` and +### GET* `/n/<id>/backdrop?<width>` ### GET* `/n/<id>/thumbnail?<t>&<width>` |