mirror of https://github.com/hzrd149/blossom.git
small fixes.
This commit is contained in:
parent
29cbfbf504
commit
7a9111f54d
11
README.md
11
README.md
|
@ -15,22 +15,32 @@ Blobs are packs of binary data addressed by their sha256 hash
|
|||
Blossom Servers expose a few endpoints for managing blobs
|
||||
|
||||
- `GET /<sha256>` (optional file `.ext`) [BUD-01](./buds/01.md#get-sha256---get-blob)
|
||||
|
||||
- `HEAD /<sha256>` (optional file `.ext`) [BUD-01](./buds/01.md#head-sha256---has-blob)
|
||||
|
||||
- `PUT /upload` [BUD-02](./buds/02.md#put-upload---upload-blob)
|
||||
- `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/<pubkey>` [BUD-02](./buds/02.md#get-listpubkey---list-blobs)
|
||||
- Returns an array of blob descriptors
|
||||
- `Authentication` _(optional)_: Signed [nostr event](./buds/02.md#list-authorization-optional)
|
||||
|
||||
- `DELETE /<sha256>` [BUD-02](./buds/02.md#delete-sha256---delete-blob)
|
||||
- `Authentication`: Signed [nostr event](./buds/02.md#delete-authorization-required)
|
||||
|
||||
- `PUT /mirror` [BUD-04](./buds/04.md#put-mirror---mirror-blob)
|
||||
- `Authentication`: Signed [nostr event](./buds/02.md#upload-authorization-required)
|
||||
|
||||
- `HEAD /media` [BUD-05](./buds/05.md#head-media)
|
||||
|
||||
- `PUT /media` [BUD-05](./buds/05.md#put-media)
|
||||
- `Authentication`: Signed [nostr event](./buds/05.md#upload-authorization)
|
||||
|
||||
- `PUT /report/<sha245>` [BUD-07](./buds/07.md)
|
||||
|
||||
## Protocol specification (BUDs)
|
||||
|
||||
BUDs stand for **Blossom Upgrade Documents**.
|
||||
|
@ -45,6 +55,7 @@ See the [BUDs](./buds) folder and specifically [BUD-01](./buds/01.md) and [BUD-0
|
|||
- [BUD-04: Mirroring blobs](./buds/04.md)
|
||||
- [BUD-05: Media optimization](./buds/05.md)
|
||||
- [BUD-06: Upload requirements](./buds/06.md)
|
||||
- [BUD-07: Blob Report](./buds/07.md)
|
||||
- [BUD-08: Nostr File Metadata Tags](./buds/08.md)
|
||||
|
||||
## Event kinds
|
||||
|
|
12
buds/07.md
12
buds/07.md
|
@ -1,10 +1,10 @@
|
|||
# BUD-07
|
||||
|
||||
## Media Report
|
||||
## Blob Report
|
||||
|
||||
`draft` `optional`
|
||||
|
||||
This bud defines a new endpoint for clients and users to report medias to servers.
|
||||
This bud defines a new endpoint for clients and users to report blobs to servers.
|
||||
|
||||
|
||||
### PUT /report/<sha256> - reporting a media
|
||||
|
@ -17,7 +17,7 @@ Example:
|
|||
{
|
||||
"kind": 1984,
|
||||
"tags": [
|
||||
["x", "<media-sha256>", "<type-based-on-nip-56>"],
|
||||
["x", "<blob-sha256>", "<type-based-on-nip-56>"],
|
||||
],
|
||||
"content": "<report details>",
|
||||
// other fields...
|
||||
|
@ -33,11 +33,11 @@ Server MUST response to report request with a successful code or a code in 4xx/5
|
|||
|
||||
### Client behavior
|
||||
|
||||
The clients can show a media report button on posts or in media details. Or they merge this with normal nostr report and send it to both relays and blossom server. other clients can receive it from relays and hide or blur reported medias from trusted friends.
|
||||
The clients can show a blob report button on posts or in blob details. Or its RECOMMENDED to merge this with normal nostr report and send it to both relays and blossom server. other clients can receive it from relays and hide or blur reported blob from trusted friends.
|
||||
|
||||
### Server behavior
|
||||
|
||||
The servers MAY keep the reports somewhere for operators to check and take action on them. they MAY use a list of trusted people or moderators to directly take action on media without operator request.
|
||||
The servers MAY keep the reports somewhere for operators to check and take action on them. they MAY use a list of trusted people or moderators to directly take action on blob without operator request.
|
||||
|
||||
Servers MAY consider removed medias sha256 as blocked in order to prevent rewrite.
|
||||
Servers MAY consider removed blobs sha256 as blocked in order to prevent rewrite.
|
||||
Servers MAY advertise a route or landing page to provide their rules and term of service which affects the report process.
|
||||
|
|
Loading…
Reference in New Issue