Skip to content

BUD-10: Thumbnails #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
v0l wants to merge 4 commits into
base: master
Choose a base branch
from
Open

BUD-10: Thumbnails #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0e80706
thumbnails
v0l Jan 31, 2025
77e46b1
Add note about nip94 tags response
v0l Jan 31, 2025
f856d00
Add note about image format
v0l Jan 31, 2025
49dc2b2
Update readme
v0l Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Blossom Servers expose a few endpoints for managing blobs

- `PUT /report` [BUD-09](./buds/09.md)

- `GET /thumb/<sha256>` (optional file `.ext`) [BUD-10](./buds/10.md)

## Protocol specification (BUDs)

BUDs stand for **Blossom Upgrade Documents**.
Expand Down
23 changes: 23 additions & 0 deletions buds/10.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# BUD-10

## Thumbnails

`draft` `optional`

To optimize image and video previews servers MAY implement this endpoint which is used to generate thumbnails.

## `GET /thumb/{sha256}[.{ext}]`

This endpoint will return a scaled down frame of the media and can be used to preview the content without downloading the entire file.

This is usefull for media browsing and management of media hosted on the server via `GET /list/{pubkey}` and `DELETE /{sha256}`.

The returned frame should be any supported `image/*` type with the same aspect ratio as the source material.

Servers MAY use the `.{ext}` in the URL or the `Accept` HTTP request header to determine which image format to generate.

The suggested scaling operation is to fix the width to 512 pixels.

Servers MAY also include the [NIP-94](https://github.com/nostr-protocol/nips/blob/master/94.md) tag `thumb` as indicated in [BUD-08](./08.md)

If the blob is not an image or video the server SHOULD reply with a `400` error code.