This commit is contained in:
k. 2025-02-03 13:54:36 +00:00 committed by GitHub
parent 9df4cc9f52
commit 77eaaf077a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

20
86.md
View File

@ -32,7 +32,9 @@ Here is a list of **methods** that MAY be supported:
* `supported_methods`: * `supported_methods`:
- **params:** `[]` - **params:** `[]`
- **result:** `["<method-name>", "<method-name>", /* rest of method names... */ ]` (Extra fields MAY be sent from relay depending on implementation.) - **result:** `["<method-name>", "<method-name>", /* rest of method names... */ ]`
Extra fields MAY be sent from the relay depending on implementation.
--- ---
@ -55,7 +57,7 @@ Here is a list of **methods** that MAY be supported:
] ]
``` ```
Extra fields MAY be sent from relay depending on implementation. Extra fields MAY be sent from the relay depending on implementation.
--- ---
@ -66,7 +68,7 @@ Extra fields MAY be sent from relay depending on implementation.
{ {
"name": "new name", "name": "new name",
"description": "new description", "description": "new description",
"icon": null // removes icon. "icon": null // remove icon.
// and more... // and more...
} }
] ]
@ -74,13 +76,13 @@ Extra fields MAY be sent from relay depending on implementation.
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
The provided input is a potentially incomplete json object of [NIP-11](./11.md) document. The provided input is a potentially incomplete json object of [NIP-11](./11.md) document.
Relay SHOULD replace provides fields with new ones, add non existing fields and remove fields set to null. Relay SHOULD replace provided fields with new ones, add non-existing fields, and remove fields set to null.
--- ---
* `list_events_needing_moderation`: * `list_events_needing_moderation`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{ "id": "<32-byte-hex>", "reason": "<optional-reason>" }, ...]` (Relay MAY return reported, muted profiles and similar events as result.) - **result:** `[{ "id": "<32-byte-hex>", "reason": "<optional-reason>" }, ...]` (Relay MAY return reported, muted profiles and similar events as a result.)
--- ---
@ -88,7 +90,7 @@ Relay SHOULD replace provides fields with new ones, add non existing fields and
- **params:** `["<32-byte-hex-public-key>", "<optional-reason>"]` - **params:** `["<32-byte-hex-public-key>", "<optional-reason>"]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
Relay MAY remove events sent by `pubkey` and prevent new events from them to be written. The relay MAY remove events sent by `pubkey` and prevent new events from being written.
--- ---
@ -182,7 +184,7 @@ Relay SHOULD delete and prevent re-broadcasting of event.
- **params:** `["<32-byte-hex-public-key>", { "allowed_methods": [...]}]` - **params:** `["<32-byte-hex-public-key>", { "allowed_methods": [...]}]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
If admin right is already granted, allowed methods list must be rewritten. If the admin right is already granted, the allowed methods list must be rewritten.
--- ---
@ -190,7 +192,7 @@ If admin right is already granted, allowed methods list must be rewritten.
- **params:** `["<32-byte-hex-public-key>", { "disallowed_methods": [...]}]` - **params:** `["<32-byte-hex-public-key>", { "disallowed_methods": [...]}]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
If resulting `allowed_methods` list for admin was empty, admin can be removed. If the resulting `allowed_methods` list for admin was empty, admin can be removed.
--- ---
@ -198,4 +200,4 @@ If resulting `allowed_methods` list for admin was empty, admin can be removed.
The request MUST contain an `Authorization` header with a valid [NIP-98](./98.md) event, except the `payload` tag is REQUIRED. The `u` tag is the relay URL. The request MUST contain an `Authorization` header with a valid [NIP-98](./98.md) event, except the `payload` tag is REQUIRED. The `u` tag is the relay URL.
If `Authorization` is not provided or is invalid, the endpoint should return a response with 401 status code. If `Authorization` is not provided or is invalid, the endpoint should return a response with a 401 status code.