diff options
Diffstat (limited to 'internal/api/client/instance/instanceget.go')
| -rw-r--r-- | internal/api/client/instance/instanceget.go | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/internal/api/client/instance/instanceget.go b/internal/api/client/instance/instanceget.go index 6ae419a83..0d53edadb 100644 --- a/internal/api/client/instance/instanceget.go +++ b/internal/api/client/instance/instanceget.go @@ -6,7 +6,28 @@ import ( "github.com/gin-gonic/gin" ) -// InstanceInformationGETHandler is for serving instance information at /api/v1/instance +// InstanceInformationGETHandler swagger:operation GET /api/v1/instance instanceGet +// +// View instance information. +// +// This is mostly provided for Mastodon application compatibility, since many apps that work with Mastodon use `/api/v1/instance` to inform their connection parameters. +// +// However, it can also be used by other instances for gathering instance information and representing instances in some UI or other. +// +// --- +// tags: +// - instance +// +// produces: +// - application/json +// +// responses: +// '200': +// description: "Instance information." +// schema: +// "$ref": "#/definitions/instance" +// '500': +// description: internal error func (m *Module) InstanceInformationGETHandler(c *gin.Context) { l := m.log.WithField("func", "InstanceInformationGETHandler") |