mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2025-06-05 21:59:39 +02:00
Frodo swaggins (#126)
* more swagger fun * document a whole bunch more stuff * more swagger yayyyyyyy * progress + go fmt
This commit is contained in:
@@ -18,8 +18,7 @@
|
||||
|
||||
package model
|
||||
|
||||
// Application represents an api Application, as defined here.
|
||||
// Primarily, application is used for allowing apps like Tusky etc to connect to Mastodon on behalf of a user.
|
||||
// Application models an api application.
|
||||
//
|
||||
// swagger:model application
|
||||
type Application struct {
|
||||
@@ -43,18 +42,30 @@ type Application struct {
|
||||
VapidKey string `json:"vapid_key,omitempty"`
|
||||
}
|
||||
|
||||
// ApplicationCreateRequest represents a POST request to https://example.org/api/v1/apps.
|
||||
// See here: https://docs.joinmastodon.org/methods/apps/
|
||||
// And here: https://docs.joinmastodon.org/client/token/
|
||||
// ApplicationCreateRequest models app create parameters.
|
||||
//
|
||||
// swagger:parameters appCreate
|
||||
type ApplicationCreateRequest struct {
|
||||
// A name for your application
|
||||
// The name of the application.
|
||||
//
|
||||
// in: formData
|
||||
// required: true
|
||||
ClientName string `form:"client_name" json:"client_name" xml:"client_name" binding:"required"`
|
||||
// Where the user should be redirected after authorization.
|
||||
// To display the authorization code to the user instead of redirecting
|
||||
// to a web page, use urn:ietf:wg:oauth:2.0:oob in this parameter.
|
||||
//
|
||||
// To display the authorization code to the user instead of redirecting to a web page, use `urn:ietf:wg:oauth:2.0:oob` in this parameter.
|
||||
//
|
||||
// in: formData
|
||||
// required: true
|
||||
RedirectURIs string `form:"redirect_uris" json:"redirect_uris" xml:"redirect_uris" binding:"required"`
|
||||
// Space separated list of scopes. If none is provided, defaults to read.
|
||||
// Space separated list of scopes.
|
||||
//
|
||||
// If no scopes are provided, defaults to `read`.
|
||||
//
|
||||
// in: formData
|
||||
Scopes string `form:"scopes" json:"scopes" xml:"scopes"`
|
||||
// A URL to the homepage of your app
|
||||
// A URL to the web page of the app (optional).
|
||||
//
|
||||
// in: formData
|
||||
Website string `form:"website" json:"website" xml:"website"`
|
||||
}
|
||||
|
Reference in New Issue
Block a user