mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-28 23:22:25 -05:00
Swagger (#124)
* start experimenting with swagger documentation * further adventures in swagger * do a few more api paths * account paths documented * go fmt * fix up some models * bit o lintin'
This commit is contained in:
parent
eb13faf54f
commit
58dddd86e0
37 changed files with 2355 additions and 169 deletions
52
docs/swagger.go
Normal file
52
docs/swagger.go
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
/*
|
||||
GoToSocial
|
||||
Copyright (C) 2021 GoToSocial Authors admin@gotosocial.org
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU Affero General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
// Package docs GoToSocial
|
||||
//
|
||||
// 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
|
||||
// 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
|
||||
// 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
|
||||
package docs
|
||||
Loading…
Add table
Add a link
Reference in a new issue