mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-02-18 03:18:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

[docs-only] Adding thumbnail query parameters to thumbnail README.md

Browse Source 
Observed with ownCloud Web UI 7.1.0 (Spaces overview):

```
scalingup: 0
preview: 1
a: 1
c: ce88e69a448ab8acf7ff554be5bb5521
x: 1000
y: 1000
```
This commit is contained in:
Michael Stingl
2023-11-30 10:07:18 +01:00
committed by GitHub
parent 12f416a18e
commit f26165910d
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
services/thumbnails/README.md
View File

@@ -39,6 +39,21 @@ If a file type was not properly assigned or the type identification failed, thum
Thumbnails can either be generated as `png`, `jpg` or `gif` files. These types are hardcoded and no other types can be requested. A requestor, like another service or a client, can request one of the available types to be generated. If more than one type is required, each type must be requested individually.
## Thumbnail Query String Parameters
Clients can request thumbnail previews for files by adding `?preview=1` to the file URL. Requests for files with thumbnail availabe respond with HTTP status `404`.
The following query parameters are supported:
| Parameter | Required | Default Value | Description |
| --------- | -------- | ---------------------------------------------------- | ----------------------------- |
| preview | YES | 1 | generates preview |
| x | YES | first x-value configured in `THUMBNAILS_RESOLUTIONS` | horizontal target size |
| y | YES | first y-value configured in `THUMBNAILS_RESOLUTIONS` | vertical target size |
| a | NO | 1 | aspect ratio |
| c | NO | ??? | ??? |
| processor | NO | ??? | preferred thumbnail processor |
## Thumbnail Resolution
Various resolutions can be defined via `THUMBNAILS_RESOLUTIONS`. A requestor can request any arbitrary resolution and the thumbnail service will use the one closest to the requested resolution. If more than one resolution is required, each resolution must be requested individually.