Update 86.md

This commit is contained in:
k. 2025-02-06 09:42:00 +03:30 committed by GitHub
parent c4384ae390
commit 34a26f950e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

57
86.md
View File

@ -30,7 +30,7 @@ Then it should return a response in the below format:
Here is a list of **methods** that MAY be supported: Here is a list of **methods** that MAY be supported:
* `supported_methods`: * `supportedmethods`:
- **params:** `[]` - **params:** `[]`
- **result:** `["<method-name>", "<method-name>", /* rest of method names... */ ]` - **result:** `["<method-name>", "<method-name>", /* rest of method names... */ ]`
@ -61,32 +61,13 @@ Extra fields MAY be sent from the relay depending on implementation.
--- ---
* `set_nip11`: * `listeventsneedingmoderation`:
- **params:**
```jsonc
[
{
"name": "new name",
"description": "new description",
"icon": null // remove icon.
// and more...
}
]
```
- **result:** `true` (a boolean always set to `true`)
The provided input is a potentially incomplete json object of [NIP-11](./11.md) document.
Relay SHOULD replace provided fields with new ones, add non-existing fields, and remove fields set to null.
---
* `list_events_needing_moderation`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{ "id": "<32-byte-hex>", "reason": "<optional-reason>" }, ...]` (Relay MAY return reported, muted profiles and similar events as a result.) - **result:** `[{ "id": "<32-byte-hex>", "reason": "<optional-reason>" }, ...]` (Relay MAY return reported, muted profiles and similar events as a result.)
--- ---
* `ban_pubkey`: * `banpubkey`:
- **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`)
@ -94,25 +75,25 @@ The relay MAY remove events sent by `pubkey` and prevent new events from being w
--- ---
* `list_banned_pubkeys`: * `listbannedpubkeys`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects) - **result:** `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects)
--- ---
* `allow_pubkey`: * `allowpubkey`:
- **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`)
--- ---
* `list_allowed_pubkeys`: * `listallowedpubkeys`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects) - **result:** `[{"pubkey": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects)
--- ---
* `ban_event`: * `banevent`:
- **params:** `["<32-byte-hex-event-id>", "<optional-reason>"]` - **params:** `["<32-byte-hex-event-id>", "<optional-reason>"]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
@ -120,67 +101,67 @@ Relay SHOULD delete and prevent re-broadcasting of event.
--- ---
* `list_banned_events`: * `listbannedevents`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects) - **result:** `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects)
--- ---
* `allow_event`: * `allowevent`:
- **params:** `["<32-byte-hex-event-id>", "<optional-reason>"]` - **params:** `["<32-byte-hex-event-id>", "<optional-reason>"]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
--- ---
* `list_allowed_events`: * `listallowedevents`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects) - **result:** `[{"id": "<32-byte-hex>", "reason": "<optional-reason>"}, ...]` (an array of objects)
--- ---
* `allow_kinds`: * `allowkinds`:
- **params:** `(<kind-number>, <another-kind-number>, /* and more... */)` - **params:** `(<kind-number>, <another-kind-number>, /* and more... */)`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
--- ---
* `disallow_kinds`: * `disallowkinds`:
- **params:** `(<kind-number>, <another-kind-number>, /* and more... */)` - **params:** `(<kind-number>, <another-kind-number>, /* and more... */)`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
--- ---
* `list_disallowed_kinds`: * `listdisallowedkinds`:
- **params:** `[]` - **params:** `[]`
- **result:** `(<kind-number>, <another-kind-number>, /* and more... */)` (an array of objects) - **result:** `(<kind-number>, <another-kind-number>, /* and more... */)` (an array of objects)
--- ---
* `list_allowed_kinds`: * `listallowedkinds`:
- **params:** `[]` - **params:** `[]`
- **result:** `(<kind-number>, <another-kind-number>, /* and more... */)` (an array of objects) - **result:** `(<kind-number>, <another-kind-number>, /* and more... */)` (an array of objects)
--- ---
* `block_ip`: * `blockip`:
- **params:** `["<ip-address>", "<optional-reason>"]` - **params:** `["<ip-address>", "<optional-reason>"]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
--- ---
* `unblock_ip`: * `unblockip`:
- **params:** `["<ip-address>"]` - **params:** `["<ip-address>"]`
- **result:** `true` (a boolean always set to `true`) - **result:** `true` (a boolean always set to `true`)
--- ---
* `list_blocked_ips`: * `listblockedips`:
- **params:** `[]` - **params:** `[]`
- **result:** `[{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...]` (an array of objects) - **result:** `[{"ip": "<ip-address>", "reason": "<optional-reason>"}, ...]` (an array of objects)
--- ---
* `grant_admin`: * `grantadmin`:
- **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`)
@ -188,7 +169,7 @@ If the admin right is already granted, the allowed methods list must be rewritte
--- ---
* `revoke_admin`: * `revokeadmin`:
- **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`)