mirrors/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2025-12-23 16:56:15 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs

Browse source
This commit is contained in:
tobi 2025-02-25 14:32:59 +01:00
commit f0b46a8c0c
3 changed files with 137 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

192
docs/api/swagger.yaml
View file

@ -4331,7 +4331,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:accounts - read:statuses
summary: See statuses posted by the requested account. summary: See statuses posted by the requested account.
tags: tags:
- accounts - accounts
@ -5004,7 +5004,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:accounts
summary: View + page through known accounts according to given filters. summary: View + page through known accounts according to given filters.
tags: tags:
- admin - admin
@ -5038,7 +5038,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:accounts
summary: View one account. summary: View one account.
tags: tags:
- admin - admin
@ -5083,7 +5083,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:accounts
summary: Perform an admin action on an account. summary: Perform an admin action on an account.
tags: tags:
- admin - admin
@ -5117,7 +5117,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:accounts
summary: Approve pending account. summary: Approve pending account.
tags: tags:
- admin - admin
@ -5163,7 +5163,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:accounts
summary: Reject pending account. summary: Reject pending account.
tags: tags:
- admin - admin
@ -5241,6 +5241,9 @@ paths:
description: not acceptable description: not acceptable
"500": "500":
description: internal server error description: internal server error
security:
- OAuth2 Bearer:
- admin:read
summary: View local and remote emojis available to / known by this instance. summary: View local and remote emojis available to / known by this instance.
tags: tags:
- admin - admin
@ -5287,7 +5290,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Upload and create a new instance emoji. summary: Upload and create a new instance emoji.
tags: tags:
- admin - admin
@ -5327,7 +5330,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Delete a **local** emoji with the given ID from the instance. summary: Delete a **local** emoji with the given ID from the instance.
tags: tags:
- admin - admin
@ -5358,6 +5361,9 @@ paths:
description: not acceptable description: not acceptable
"500": "500":
description: internal server error description: internal server error
security:
- OAuth2 Bearer:
- admin:read
summary: Get the admin view of a single emoji. summary: Get the admin view of a single emoji.
tags: tags:
- admin - admin
@ -5429,7 +5435,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Perform admin action on a local or remote emoji known to this instance. summary: Perform admin action on a local or remote emoji known to this instance.
tags: tags:
- admin - admin
@ -5457,6 +5463,9 @@ paths:
description: not acceptable description: not acceptable
"500": "500":
description: internal server error description: internal server error
security:
- OAuth2 Bearer:
- admin:read
summary: Get a list of existing emoji categories. summary: Get a list of existing emoji categories.
tags: tags:
- admin - admin
@ -5489,7 +5498,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Perform a GET to the specified ActivityPub URL and return detailed debugging information. summary: Perform a GET to the specified ActivityPub URL and return detailed debugging information.
tags: tags:
- debug - debug
@ -5514,7 +5523,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Sweep/clear all in-memory caches. summary: Sweep/clear all in-memory caches.
tags: tags:
- debug - debug
@ -5549,7 +5558,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:domain_allows
summary: View all domain allows currently in place. summary: View all domain allows currently in place.
tags: tags:
- admin - admin
@ -5612,7 +5621,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:domain_allows
summary: Create one or more domain allows, from a string or a file. summary: Create one or more domain allows, from a string or a file.
tags: tags:
- admin - admin
@ -5648,7 +5657,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:domain_allows
summary: Delete domain allow with the given ID. summary: Delete domain allow with the given ID.
tags: tags:
- admin - admin
@ -5681,7 +5690,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:domain_allows
summary: View domain allow with the given ID. summary: View domain allow with the given ID.
tags: tags:
- admin - admin
@ -5716,7 +5725,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:domain_blocks
summary: View all domain blocks currently in place. summary: View all domain blocks currently in place.
tags: tags:
- admin - admin
@ -5779,7 +5788,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:domain_blocks
summary: Create one or more domain blocks, from a string or a file. summary: Create one or more domain blocks, from a string or a file.
tags: tags:
- admin - admin
@ -5815,7 +5824,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:domain_blocks
summary: Delete domain block with the given ID. summary: Delete domain block with the given ID.
tags: tags:
- admin - admin
@ -5848,7 +5857,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:domain_blocks
summary: View domain block with the given ID. summary: View domain block with the given ID.
tags: tags:
- admin - admin
@ -5900,7 +5909,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Force expiry of cached public keys for all accounts on the given domain stored in your database. summary: Force expiry of cached public keys for all accounts on the given domain stored in your database.
tags: tags:
- admin - admin
@ -5976,7 +5985,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: View domain permission drafts. summary: View domain permission drafts.
tags: tags:
- admin - admin
@ -6027,7 +6036,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Create a domain permission draft with the given parameters. summary: Create a domain permission draft with the given parameters.
tags: tags:
- admin - admin
@ -6059,7 +6068,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: Get domain permission draft with the given ID. summary: Get domain permission draft with the given ID.
tags: tags:
- admin - admin
@ -6101,7 +6110,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Accept a domain permission draft, turning it into an enforced domain permission. summary: Accept a domain permission draft, turning it into an enforced domain permission.
tags: tags:
- admin - admin
@ -6143,7 +6152,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Remove a domain permission draft, optionally ignoring all future drafts targeting the given domain. summary: Remove a domain permission draft, optionally ignoring all future drafts targeting the given domain.
tags: tags:
- admin - admin
@ -6211,7 +6220,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: View domain permission excludes. summary: View domain permission excludes.
tags: tags:
- admin - admin
@ -6254,7 +6263,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Create a domain permission exclude with the given parameters. summary: Create a domain permission exclude with the given parameters.
tags: tags:
- admin - admin
@ -6288,7 +6297,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Remove a domain permission exclude. summary: Remove a domain permission exclude.
tags: tags:
- admin - admin
@ -6319,7 +6328,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: Get domain permission exclude with the given ID. summary: Get domain permission exclude with the given ID.
tags: tags:
- admin - admin
@ -6387,7 +6396,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: View domain permission subscriptions. summary: View domain permission subscriptions.
tags: tags:
- admin - admin
@ -6462,7 +6471,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Create a domain permission subscription with the given parameters. summary: Create a domain permission subscription with the given parameters.
tags: tags:
- admin - admin
@ -6535,7 +6544,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Update a domain permission subscription with the given parameters. summary: Update a domain permission subscription with the given parameters.
tags: tags:
- admin - admin
@ -6567,7 +6576,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: Get domain permission subscription with the given ID. summary: Get domain permission subscription with the given ID.
tags: tags:
- admin - admin
@ -6611,7 +6620,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Remove a domain permission subscription. summary: Remove a domain permission subscription.
tags: tags:
- admin - admin
@ -6651,7 +6660,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Test one domain permission subscription by making your instance fetch and parse it *without creating permissions*. summary: Test one domain permission subscription by making your instance fetch and parse it *without creating permissions*.
tags: tags:
- admin - admin
@ -6688,7 +6697,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: View all domain permission subscriptions of the given permission type, in priority order (highest to lowest). summary: View all domain permission subscriptions of the given permission type, in priority order (highest to lowest).
tags: tags:
- admin - admin
@ -6733,7 +6742,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Send a generic test email to a specified email address. summary: Send a generic test email to a specified email address.
tags: tags:
- admin - admin
@ -6802,7 +6811,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Create new "allow" HTTP request header filter. summary: Create new "allow" HTTP request header filter.
tags: tags:
- admin - admin
@ -6830,7 +6839,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Delete the "allow" header filter with the given ID. summary: Delete the "allow" header filter with the given ID.
tags: tags:
- admin - admin
@ -6859,7 +6868,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: Get "allow" header filter with the given ID. summary: Get "allow" header filter with the given ID.
tags: tags:
- admin - admin
@ -6928,7 +6937,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Create new "block" HTTP request header filter. summary: Create new "block" HTTP request header filter.
tags: tags:
- admin - admin
@ -6956,7 +6965,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Delete the "block" header filter with the given ID. summary: Delete the "block" header filter with the given ID.
tags: tags:
- admin - admin
@ -6985,7 +6994,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: Get "block" header filter with the given ID. summary: Get "block" header filter with the given ID.
tags: tags:
- admin - admin
@ -7014,7 +7023,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: View instance rules, with IDs. summary: View instance rules, with IDs.
tags: tags:
- admin - admin
@ -7050,7 +7059,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Create a new instance rule. summary: Create a new instance rule.
tags: tags:
- admin - admin
@ -7086,7 +7095,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Delete an existing instance rule. summary: Delete an existing instance rule.
tags: tags:
- admin - admin
@ -7117,7 +7126,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read
summary: View instance rule with the given id. summary: View instance rule with the given id.
tags: tags:
- admin - admin
@ -7159,7 +7168,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Update an existing instance rule. summary: Update an existing instance rule.
tags: tags:
- admin - admin
@ -7199,7 +7208,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Clean up remote media older than the specified number of days. summary: Clean up remote media older than the specified number of days.
tags: tags:
- admin - admin
@ -7233,7 +7242,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Refetch media specified in the database but missing from storage. summary: Refetch media specified in the database but missing from storage.
tags: tags:
- admin - admin
@ -7307,7 +7316,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:reports
summary: View user moderation reports. summary: View user moderation reports.
tags: tags:
- admin - admin
@ -7339,7 +7348,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:reports
summary: View user moderation report with the given id. summary: View user moderation report with the given id.
tags: tags:
- admin - admin
@ -7381,7 +7390,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write:reports
summary: Mark a report as resolved. summary: Mark a report as resolved.
tags: tags:
- admin - admin
@ -7408,8 +7417,7 @@ paths:
"500": "500":
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer: []
- read:announcements
summary: Get an array of currently active announcements. summary: Get an array of currently active announcements.
tags: tags:
- announcements - announcements
@ -7723,8 +7731,7 @@ paths:
"500": "500":
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer: []
- read:custom_emojis
summary: Get an array of custom emojis available on the instance. summary: Get an array of custom emojis available on the instance.
tags: tags:
- custom_emojis - custom_emojis
@ -7764,7 +7771,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:follows - read:accounts
summary: Export a CSV file of accounts that follow you. summary: Export a CSV file of accounts that follow you.
tags: tags:
- import-export - import-export
@ -7846,7 +7853,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:account - read:accounts
summary: Returns informational stats on the number of items that can be exported for requesting account. summary: Returns informational stats on the number of items that can be exported for requesting account.
tags: tags:
- import-export - import-export
@ -8423,7 +8430,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- write:accounts - write
summary: Upload some CSV-formatted data to your account. summary: Upload some CSV-formatted data to your account.
tags: tags:
- import-export - import-export
@ -8517,7 +8524,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:write
summary: Update your instance information and/or upload a new avatar/header for the instance. summary: Update your instance information and/or upload a new avatar/header for the instance.
tags: tags:
- instance - instance
@ -8569,6 +8576,8 @@ paths:
description: not acceptable description: not acceptable
"500": "500":
description: internal server error description: internal server error
security:
- OAuth2 Bearer: []
tags: tags:
- instance - instance
/api/v1/instance/rules: /api/v1/instance/rules:
@ -9643,7 +9652,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:notifications - write:notifications
summary: Clear/delete all notifications for currently authorized user. summary: Clear/delete all notifications for currently authorized user.
tags: tags:
- notifications - notifications
@ -10158,7 +10167,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:reports - read:accounts
summary: See reports created by the requesting account. summary: See reports created by the requesting account.
tags: tags:
- reports - reports
@ -10270,7 +10279,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:reports - read:accounts
summary: Get one report with the given id. summary: Get one report with the given id.
tags: tags:
- reports - reports
@ -10677,7 +10686,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- write:statuses - write:bookmarks
summary: Bookmark status with the given ID. summary: Bookmark status with the given ID.
tags: tags:
- statuses - statuses
@ -11035,7 +11044,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- write:statuses - write:bookmarks
summary: Unbookmark status with the given ID. summary: Unbookmark status with the given ID.
tags: tags:
- statuses - statuses
@ -11069,7 +11078,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- write:statuses - write:favourites
summary: Unstar/unlike/unfavourite the given status. summary: Unstar/unlike/unfavourite the given status.
tags: tags:
- statuses - statuses
@ -11313,8 +11322,7 @@ paths:
"500": "500":
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer: []
- read:follows
summary: Get details for a hashtag, including whether you currently follow it. summary: Get details for a hashtag, including whether you currently follow it.
tags: tags:
- tags - tags
@ -11642,7 +11650,7 @@ paths:
description: internal error description: internal error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- read:user - read:accounts
summary: Get your own user model. summary: Get your own user model.
tags: tags:
- user - user
@ -11687,7 +11695,7 @@ paths:
description: internal error description: internal error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- write:user - write:accounts
summary: Request changing the email address of authenticated user. summary: Request changing the email address of authenticated user.
tags: tags:
- user - user
@ -11736,7 +11744,7 @@ paths:
description: internal error description: internal error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- write:user - write:accounts
summary: Change the password of authenticated user. summary: Change the password of authenticated user.
tags: tags:
- user - user
@ -11837,7 +11845,7 @@ paths:
description: internal server error description: internal server error
security: security:
- OAuth2 Bearer: - OAuth2 Bearer:
- admin - admin:read:accounts
summary: View + page through known accounts according to given filters. summary: View + page through known accounts according to given filters.
tags: tags:
- admin - admin
@ -12724,32 +12732,44 @@ securityDefinitions:
flow: accessCode flow: accessCode
scopes: scopes:
admin: grants admin access to everything admin: grants admin access to everything
admin:accounts: grants admin access to accounts admin:read: grants admin read access to everything
admin:read:accounts: grants admin read access to accounts
admin:read:domain_allows: grants admin read access to domain_allows
admin:read:domain_blocks: grants admin read access to domain_blocks
admin:read:reports: grants admin read access to reports
admin:write: grants admin write access to everything
admin:write:accounts: grants write read access to accounts
admin:write:domain_allows: grants admin write access to domain_allows
admin:write:domain_blocks: grants write read access to domain_blocks
admin:write:reports: grants admin write access to reports
profile: grants read access to verify_credentials
push: grants read/write access to push
read: grants read access to everything read: grants read access to everything
read:accounts: grants read access to accounts read:accounts: grants read access to accounts
read:blocks: grant read access to blocks read:blocks: grants read access to blocks
read:custom_emojis: grant read access to custom_emojis read:bookmarks: grants read access to bookmarks
read:favourites: grant read access to favourites read:favourites: grants read access to accounts
read:filters: grant read access to filters read:filters: grants read access to filters
read:follows: grant read access to follows read:follows: grants read access to follows
read:lists: grant read access to lists read:lists: grants read access to lists
read:media: grant read access to media read:mutes: grants read access to mutes
read:mutes: grant read access to mutes
read:notifications: grants read access to notifications read:notifications: grants read access to notifications
read:search: grant read access to searches read:search: grants read access to search
read:statuses: grants read access to statuses read:statuses: grants read access to statuses
read:streaming: grants read access to streaming api
read:user: grants read access to user-level info
write: grants write access to everything write: grants write access to everything
write:accounts: grants write access to accounts write:accounts: grants write access to accounts
write:blocks: grants write access to blocks write:blocks: grants write access to blocks
write:bookmarks: grants write access to bookmarks
write:conversations: grants write access to conversations
write:favourites: grants write access to favourites
write:filters: grants write access to filters write:filters: grants write access to filters
write:follows: grants write access to follows write:follows: grants write access to follows
write:lists: grants write access to lists write:lists: grants write access to lists
write:media: grants write access to media write:media: grants write access to media
write:mutes: grants write access to mutes write:mutes: grants write access to mutes
write:notifications: grants write access to notifications
write:reports: grants write access to reports
write:statuses: grants write access to statuses write:statuses: grants write access to statuses
write:user: grants write access to user-level info
tokenUrl: https://example.org/oauth/token tokenUrl: https://example.org/oauth/token
type: oauth2 type: oauth2
swagger: "2.0" swagger: "2.0"

44
docs/swagger.go
View file

@ -32,32 +32,44 @@
// tokenUrl: https://example.org/oauth/token // tokenUrl: https://example.org/oauth/token
// scopes: // scopes:
// read: grants read access to everything // read: grants read access to everything
// read:accounts: grants read access to accounts
// read:blocks: grant read access to blocks
// read:custom_emojis: grant read access to custom_emojis
// read:favourites: grant read access to favourites
// read:filters: grant read access to filters
// read:follows: grant read access to follows
// read:lists: grant read access to lists
// read:media: grant read access to media
// read:mutes: grant read access to mutes
// read:search: grant read access to searches
// read:statuses: grants read access to statuses
// read:streaming: grants read access to streaming api
// read:user: grants read access to user-level info
// read:notifications: grants read access to notifications
// write: grants write access to everything // write: grants write access to everything
// push: grants read/write access to push
// profile: grants read access to verify_credentials
// read:accounts: grants read access to accounts
// write:accounts: grants write access to accounts // write:accounts: grants write access to accounts
// read:blocks: grants read access to blocks
// write:blocks: grants write access to blocks // write:blocks: grants write access to blocks
// read:bookmarks: grants read access to bookmarks
// write:bookmarks: grants write access to bookmarks
// write:conversations: grants write access to conversations
// read:favourites: grants read access to accounts
// write:favourites: grants write access to favourites
// read:filters: grants read access to filters
// write:filters: grants write access to filters // write:filters: grants write access to filters
// read:follows: grants read access to follows
// write:follows: grants write access to follows // write:follows: grants write access to follows
// read:lists: grants read access to lists
// write:lists: grants write access to lists // write:lists: grants write access to lists
// write:media: grants write access to media // write:media: grants write access to media
// read:mutes: grants read access to mutes
// write:mutes: grants write access to mutes // write:mutes: grants write access to mutes
// read:notifications: grants read access to notifications
// write:notifications: grants write access to notifications
// write:reports: grants write access to reports
// read:search: grants read access to search
// read:statuses: grants read access to statuses
// write:statuses: grants write access to statuses // write:statuses: grants write access to statuses
// write:user: grants write access to user-level info
// admin: grants admin access to everything // admin: grants admin access to everything
// admin:accounts: grants admin access to accounts // admin:read: grants admin read access to everything
// admin:write: grants admin write access to everything
// admin:read:accounts: grants admin read access to accounts
// admin:write:accounts: grants write read access to accounts
// admin:read:reports: grants admin read access to reports
// admin:write:reports: grants admin write access to reports
// admin:read:domain_allows: grants admin read access to domain_allows
// admin:write:domain_allows: grants admin write access to domain_allows
// admin:read:domain_blocks: grants admin read access to domain_blocks
// admin:write:domain_blocks: grants write read access to domain_blocks
// OAuth2 Application: // OAuth2 Application:
// type: oauth2 // type: oauth2
// flow: application // flow: application

4
internal/api/util/scopes.go
View file

@ -17,7 +17,9 @@
package util package util
import "strings" import (
"strings"
)
type Scope string type Scope string