diff options
| author | Ivan Tashkinov <ivantashkinov@gmail.com> | 2020-11-19 19:30:02 +0300 |
|---|---|---|
| committer | Ivan Tashkinov <ivantashkinov@gmail.com> | 2020-11-19 19:30:02 +0300 |
| commit | e164c37139c4365d7d46a2a990b364ad26dfdbf7 (patch) | |
| tree | 249c7694237e657bf3af512791e0553ef782e13d /docs/API | |
| parent | fcad3e716ad8dc60bd3d94e5b2e0aa18af4c9376 (diff) | |
| download | pleroma-e164c37139c4365d7d46a2a990b364ad26dfdbf7.tar.gz | |
[#2301] Proper handling of `User.is_discoverable`: users appear in in-service search but are hidden from external services like search bots.
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/admin_api.md | 2 | ||||
| -rw-r--r-- | docs/API/differences_in_mastoapi_responses.md | 4 |
2 files changed, 3 insertions, 3 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index 19ac6a65f..266f8cef8 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -554,7 +554,7 @@ Response: * `show_role` * `skip_thread_containment` * `fields` - * `discoverable` + * `is_discoverable` * `actor_type` * Responses: diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md index 843496482..6b0ad85d1 100644 --- a/docs/API/differences_in_mastoapi_responses.md +++ b/docs/API/differences_in_mastoapi_responses.md @@ -84,7 +84,7 @@ Has these additional fields under the `pleroma` object: - `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown - `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API -- `discoverable`: boolean, true when the user allows discovery of the account in search results and other services. +- `discoverable`: boolean, true when the user allows external services (search bots) etc. to index / list the account (regardless of this setting, user will still appear in regular search results) - `actor_type`: string, the type of this account. ## Conversations @@ -207,7 +207,7 @@ Additional parameters can be added to the JSON body/Form data: - `skip_thread_containment` - if true, skip filtering out broken threads - `allow_following_move` - if true, allows automatically follow moved following accounts - `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset. -- `discoverable` - if true, discovery of this account in search results and other services is allowed. +- `discoverable` - if true, external services (search bots) etc. are allowed to index / list the account (regardless of this setting, user will still appear in regular search results). - `actor_type` - the type of this account. - `accepts_chat_messages` - if false, this account will reject all chat messages. |