From 6a101237902dd9fd7205967dc9e5a95ce8d1b765 Mon Sep 17 00:00:00 2001
From: tobi <31960611+tsmethurst@users.noreply.github.com>
Date: Tue, 13 Sep 2022 13:30:07 +0200
Subject: [docs] Swagger document `/api/v1/custom_emojis` (#824)

---
 internal/api/client/emoji/emojisget.go | 29 ++++++++++++++++++++++++++++-
 1 file changed, 28 insertions(+), 1 deletion(-)

(limited to 'internal/api/client')

diff --git a/internal/api/client/emoji/emojisget.go b/internal/api/client/emoji/emojisget.go
index 488aad78b..c5a2ced63 100644
--- a/internal/api/client/emoji/emojisget.go
+++ b/internal/api/client/emoji/emojisget.go
@@ -9,7 +9,34 @@ import (
 	"github.com/superseriousbusiness/gotosocial/internal/oauth"
 )
 
-// EmojisGETHandler returns a list of custom emojis enabled on the instance
+// EmojisGETHandler swagger:operation GET /api/v1/custom_emojis customEmojisGet
+//
+// Get an array of custom emojis available on the instance.
+//
+// ---
+// tags:
+// - custom_emojis
+//
+// produces:
+// - application/json
+//
+// security:
+// - OAuth2 Bearer:
+//   - read:custom_emojis
+//
+// responses:
+//   '200':
+//     description: Array of custom emojis.
+//     schema:
+//       type: array
+//       items:
+//         "$ref": "#/definitions/emoji"
+//   '401':
+//      description: unauthorized
+//   '406':
+//      description: not acceptable
+//   '500':
+//      description: internal server error
 func (m *Module) EmojisGETHandler(c *gin.Context) {
 	if _, err := oauth.Authed(c, true, true, true, true); err != nil {
 		api.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGet)
-- 
cgit v1.2.3