From a3b1ef577b8fdd579cb2ddef197a1a5a0c1cbba3 Mon Sep 17 00:00:00 2001 From: hzrd149 Date: Tue, 25 Nov 2025 08:45:35 -0600 Subject: [PATCH] unrecommend the list endpoint --- README.md | 2 +- buds/02.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a8bfc2f..45c35f8 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Blossom Servers expose a few endpoints for managing blobs - `Authentication`: Signed [nostr event](./buds/02.md#upload-authorization-required) - Return a blob descriptor - `HEAD /upload` [BUD-06](./buds/06.md#head-upload---upload-requirements) -- `GET /list/` [BUD-02](./buds/02.md#get-listpubkey---list-blobs) +- `GET /list/` [BUD-02](./buds/02.md#get-listpubkey---list-blobs-unrecommended) _(optional, unrecommended)_ - Returns an array of blob descriptors - `Authentication` _(optional)_: Signed [nostr event](./buds/02.md#list-authorization-optional) - `DELETE /` [BUD-02](./buds/02.md#delete-sha256---delete-blob) diff --git a/buds/02.md b/buds/02.md index 3aec190..c5711a5 100644 --- a/buds/02.md +++ b/buds/02.md @@ -76,7 +76,9 @@ Example Authorization event: } ``` -## GET /list/pubkey - List Blobs (Optional) +## GET /list/pubkey - List Blobs (Unrecommended) + +**Note:** The `/list` endpoint is optional and unrecommended. It is not necessary for all servers to implement the `/list` endpoint. Servers MAY implement this endpoint, but are not required to do so. The `/list/` endpoint MUST return a JSON array of [Blob Descriptor](#blob-descriptor) that were uploaded by the specified pubkey