docs

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2023 License: AGPL-3.0 Imports: 0 Imported by: 0

Documentation

Overview

GoToSocial Swagger documentation.

Schemes: https, http
BasePath: /
Version: REPLACE_ME
Host: example.org
License: AGPL3 https://www.gnu.org/licenses/agpl-3.0.en.html
Contact: GoToSocial Authors <admin@gotosocial.org>

SecurityDefinitions:
  OAuth2 Bearer:
    type: oauth2
    flow: accessCode
    authorizationUrl: https://example.org/oauth/authorize
    tokenUrl: https://example.org/oauth/token
    scopes:
      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:follows: grant read access to follows
      read:media: grant read access to media
      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:accounts: grants write access to accounts
      write:blocks: grants write access to blocks
      write:follows: grants write access to follows
      write:media: grants write access to media
      write:statuses: grants write access to statuses
      write:user: grants write access to user-level info
      admin: grants admin access to everything
      admin:accounts: grants admin access to accounts
  OAuth2 Application:
    type: oauth2
    flow: application
    tokenUrl: https://example.org/oauth/token
    scopes:
      write:accounts: grants write access to accounts

swagger:meta

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL