diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/swagger.yaml | 6 | ||||
| -rw-r--r-- | docs/configuration/instance.md | 15 | ||||
| -rw-r--r-- | docs/swagger.go | 2 |
3 files changed, 22 insertions, 1 deletions
diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml index 52d024304..3ef284ef1 100644 --- a/docs/api/swagger.yaml +++ b/docs/api/swagger.yaml @@ -3752,6 +3752,7 @@ info: read:applications: grants read access to user-managed applications read:blocks: grants read access to blocks read:bookmarks: grants read access to bookmarks + read:custom_emojis: grants read access to custom emojis read:favourites: grants read access to accounts read:filters: grants read access to filters read:follows: grants read access to follows @@ -8126,6 +8127,7 @@ paths: - conversations /api/v1/custom_emojis: get: + description: If the instance config setting `instance-expose-custom-emojis` is `true` then authentication is not required. operationId: customEmojisGet produces: - application/json @@ -8143,7 +8145,8 @@ paths: "500": description: internal server error security: - - OAuth2 Bearer: [] + - OAuth2 Bearer: + - read:custom_emojis summary: Get an array of custom emojis available on the instance. tags: - custom_emojis @@ -13588,6 +13591,7 @@ securityDefinitions: read:applications: grants read access to user-managed applications read:blocks: grants read access to blocks read:bookmarks: grants read access to bookmarks + read:custom_emojis: grants read access to custom emojis read:favourites: grants read access to accounts read:filters: grants read access to filters read:follows: grants read access to follows diff --git a/docs/configuration/instance.md b/docs/configuration/instance.md index 1b8282a27..3c856634b 100644 --- a/docs/configuration/instance.md +++ b/docs/configuration/instance.md @@ -139,6 +139,21 @@ instance-expose-blocklist-web: false # Default: false instance-expose-public-timeline: false +# Bool. Allow unauthenticated access to /api/v1/custom_emojis, which +# exposes the list of custom emojis available to users on this server. +# +# Setting this to 'true' may alleviate issues with clients that do not +# provide an access token in their requests to the emojis endpoint, but +# it also means that anyone can look at what emojis are installed on your +# instance, which may present privacy / safety issues. +# +# Even if set to 'false', authenticated users (ie., instance members) +# will still be able to query the endpoint using an access token. +# +# Options: [true, false] +# Default: false +instance-expose-custom-emojis: false + # Bool. This flag tweaks whether GoToSocial will deliver ActivityPub messages # to the shared inbox of a recipient, if one is available, instead of delivering # each message to each actor who should receive a message individually. diff --git a/docs/swagger.go b/docs/swagger.go index 500abd7a2..c549a3de3 100644 --- a/docs/swagger.go +++ b/docs/swagger.go @@ -41,6 +41,7 @@ // - read:applications: grants read access to user-managed applications // - read:blocks: grants read access to blocks // - read:bookmarks: grants read access to bookmarks +// - read:custom_emojis: grants read access to custom emojis // - read:favourites: grants read access to accounts // - read:filters: grants read access to filters // - read:follows: grants read access to follows @@ -99,6 +100,7 @@ // read:applications: grants read access to user-managed applications // read:blocks: grants read access to blocks // read:bookmarks: grants read access to bookmarks +// read:custom_emojis: grants read access to custom emojis // read:favourites: grants read access to accounts // read:filters: grants read access to filters // read:follows: grants read access to follows |