From cd4cfa6a70a2dfd235fa02ae66cc02e112af1f57 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Fri, 28 Mar 2025 22:12:07 +0100 Subject: [PATCH] fix(api): :bug: Add tags to all API routes that were missing one --- api/api/auth/redirect/index.ts | 1 + api/api/v1/accounts/:id/roles/:role_id/index.ts | 1 + api/api/v1/accounts/lookup/index.ts | 1 + api/api/v1/emojis/index.ts | 1 + api/api/v1/notifications/destroy_multiple/index.ts | 1 + api/api/v1/notifications/index.ts | 1 + api/api/v1/roles/:id/index.ts | 3 +++ api/api/v1/roles/index.ts | 2 ++ api/well-known/openid-configuration/index.ts | 1 + plugins/openid/routes/authorize.ts | 1 + plugins/openid/routes/jwks.ts | 1 + plugins/openid/routes/oauth/callback.ts | 1 + plugins/openid/routes/oauth/revoke.ts | 1 + plugins/openid/routes/oauth/sso.ts | 1 + plugins/openid/routes/oauth/token.ts | 1 + plugins/openid/routes/sso/:id/index.ts | 2 ++ plugins/openid/routes/sso/index.ts | 2 ++ 17 files changed, 22 insertions(+) diff --git a/api/api/auth/redirect/index.ts b/api/api/auth/redirect/index.ts index fb6df120..34aa7f68 100644 --- a/api/api/auth/redirect/index.ts +++ b/api/api/auth/redirect/index.ts @@ -19,6 +19,7 @@ const route = createRoute({ summary: "OAuth Code flow", description: "Redirects to the application, or back to login if the code is invalid", + tags: ["OpenID"], responses: { 302: { description: diff --git a/api/api/v1/accounts/:id/roles/:role_id/index.ts b/api/api/v1/accounts/:id/roles/:role_id/index.ts index 8f918a87..d1caa093 100644 --- a/api/api/v1/accounts/:id/roles/:role_id/index.ts +++ b/api/api/v1/accounts/:id/roles/:role_id/index.ts @@ -39,6 +39,7 @@ const routeDelete = createRoute({ method: "delete", path: "/api/v1/accounts/{id}/roles/{role_id}", summary: "Remove role from user", + tags: ["Accounts"], middleware: [ auth({ auth: true, diff --git a/api/api/v1/accounts/lookup/index.ts b/api/api/v1/accounts/lookup/index.ts index c422bcf5..27e3d43a 100644 --- a/api/api/v1/accounts/lookup/index.ts +++ b/api/api/v1/accounts/lookup/index.ts @@ -15,6 +15,7 @@ const route = createRoute({ summary: "Lookup account ID from Webfinger address", description: "Quickly lookup a username to see if it is available, skipping WebFinger resolution.", + tags: ["Accounts"], middleware: [ auth({ auth: false, diff --git a/api/api/v1/emojis/index.ts b/api/api/v1/emojis/index.ts index 2a5a39ef..cc9e8e61 100644 --- a/api/api/v1/emojis/index.ts +++ b/api/api/v1/emojis/index.ts @@ -40,6 +40,7 @@ const route = createRoute({ path: "/api/v1/emojis", summary: "Upload emoji", description: "Upload a new emoji to the server.", + tags: ["Emojis"], middleware: [ auth({ auth: true, diff --git a/api/api/v1/notifications/destroy_multiple/index.ts b/api/api/v1/notifications/destroy_multiple/index.ts index a1b90a1b..b866e9b8 100644 --- a/api/api/v1/notifications/destroy_multiple/index.ts +++ b/api/api/v1/notifications/destroy_multiple/index.ts @@ -13,6 +13,7 @@ const route = createRoute({ method: "delete", path: "/api/v1/notifications/destroy_multiple", summary: "Dismiss multiple notifications", + tags: ["Notifications"], middleware: [ auth({ auth: true, diff --git a/api/api/v1/notifications/index.ts b/api/api/v1/notifications/index.ts index 1644caab..d762dd05 100644 --- a/api/api/v1/notifications/index.ts +++ b/api/api/v1/notifications/index.ts @@ -19,6 +19,7 @@ const route = createRoute({ externalDocs: { url: "https://docs.joinmastodon.org/methods/notifications/#get", }, + tags: ["Notifications"], middleware: [ auth({ auth: true, diff --git a/api/api/v1/roles/:id/index.ts b/api/api/v1/roles/:id/index.ts index c4254cc6..99cfd70a 100644 --- a/api/api/v1/roles/:id/index.ts +++ b/api/api/v1/roles/:id/index.ts @@ -9,6 +9,7 @@ const routeGet = createRoute({ method: "get", path: "/api/v1/roles/{id}", summary: "Get role data", + tags: ["Roles"], middleware: [ auth({ auth: true, @@ -37,6 +38,7 @@ const routePatch = createRoute({ method: "patch", path: "/api/v1/roles/{id}", summary: "Update role data", + tags: ["Roles"], middleware: [ auth({ auth: true, @@ -68,6 +70,7 @@ const routeDelete = createRoute({ method: "delete", path: "/api/v1/roles/{id}", summary: "Delete role", + tags: ["Roles"], middleware: [ auth({ auth: true, diff --git a/api/api/v1/roles/index.ts b/api/api/v1/roles/index.ts index 7842166a..cb7cdf81 100644 --- a/api/api/v1/roles/index.ts +++ b/api/api/v1/roles/index.ts @@ -9,6 +9,7 @@ const routeGet = createRoute({ method: "get", path: "/api/v1/roles", summary: "Get all roles", + tags: ["Roles"], middleware: [ auth({ auth: true, @@ -30,6 +31,7 @@ const routePost = createRoute({ method: "post", path: "/api/v1/roles", summary: "Create a new role", + tags: ["Roles"], middleware: [ auth({ auth: true, diff --git a/api/well-known/openid-configuration/index.ts b/api/well-known/openid-configuration/index.ts index a35e9094..499e1523 100644 --- a/api/well-known/openid-configuration/index.ts +++ b/api/well-known/openid-configuration/index.ts @@ -6,6 +6,7 @@ const route = createRoute({ method: "get", path: "/.well-known/openid-configuration", summary: "OpenID Configuration", + tags: ["OpenID"], responses: { 200: { description: "OpenID Configuration", diff --git a/plugins/openid/routes/authorize.ts b/plugins/openid/routes/authorize.ts index d6e34a99..cf0a365a 100644 --- a/plugins/openid/routes/authorize.ts +++ b/plugins/openid/routes/authorize.ts @@ -69,6 +69,7 @@ export default (plugin: PluginType): void => { method: "post", path: "/oauth/authorize", + tags: ["OpenID"], middleware: [ auth({ auth: false, diff --git a/plugins/openid/routes/jwks.ts b/plugins/openid/routes/jwks.ts index 26b7ac23..59e71bf0 100644 --- a/plugins/openid/routes/jwks.ts +++ b/plugins/openid/routes/jwks.ts @@ -10,6 +10,7 @@ export default (plugin: PluginType): void => { method: "get", path: "/.well-known/jwks", summary: "JWK Set", + tags: ["OpenID"], responses: { 200: { description: "JWK Set", diff --git a/plugins/openid/routes/oauth/callback.ts b/plugins/openid/routes/oauth/callback.ts index 803fc592..c8c1b1ce 100644 --- a/plugins/openid/routes/oauth/callback.ts +++ b/plugins/openid/routes/oauth/callback.ts @@ -33,6 +33,7 @@ export default (plugin: PluginType): void => { method: "get", path: "/oauth/sso/{issuer}/callback", summary: "SSO callback", + tags: ["OpenID"], description: "After the user has authenticated to an external OpenID provider, they are redirected here to complete the OAuth flow and get a code", middleware: [plugin.middleware] as const, diff --git a/plugins/openid/routes/oauth/revoke.ts b/plugins/openid/routes/oauth/revoke.ts index 4a58ffc7..17710803 100644 --- a/plugins/openid/routes/oauth/revoke.ts +++ b/plugins/openid/routes/oauth/revoke.ts @@ -20,6 +20,7 @@ export default (plugin: PluginType): void => { method: "post", path: "/oauth/revoke", summary: "Revoke token", + tags: ["OpenID"], middleware: [jsonOrForm(), plugin.middleware], request: { body: { diff --git a/plugins/openid/routes/oauth/sso.ts b/plugins/openid/routes/oauth/sso.ts index 8168443d..bbbf4582 100644 --- a/plugins/openid/routes/oauth/sso.ts +++ b/plugins/openid/routes/oauth/sso.ts @@ -27,6 +27,7 @@ export default (plugin: PluginType): void => { method: "get", path: "/oauth/sso", summary: "Initiate SSO login flow", + tags: ["OpenID"], request: { query: schemas.query, }, diff --git a/plugins/openid/routes/oauth/token.ts b/plugins/openid/routes/oauth/token.ts index 01ef7aab..d4a64d88 100644 --- a/plugins/openid/routes/oauth/token.ts +++ b/plugins/openid/routes/oauth/token.ts @@ -45,6 +45,7 @@ export default (plugin: PluginType): void => { method: "post", path: "/oauth/token", summary: "Get token", + tags: ["OpenID"], middleware: [jsonOrForm(), plugin.middleware], request: { body: { diff --git a/plugins/openid/routes/sso/:id/index.ts b/plugins/openid/routes/sso/:id/index.ts index 0c8cd0b8..278bbbac 100644 --- a/plugins/openid/routes/sso/:id/index.ts +++ b/plugins/openid/routes/sso/:id/index.ts @@ -15,6 +15,7 @@ export default (plugin: PluginType): void => { method: "get", path: "/api/v1/sso/{id}", summary: "Get linked account", + tags: ["SSO"], middleware: [ auth({ auth: true, @@ -93,6 +94,7 @@ export default (plugin: PluginType): void => { method: "delete", path: "/api/v1/sso/{id}", summary: "Unlink account", + tags: ["SSO"], middleware: [ auth({ auth: true, diff --git a/plugins/openid/routes/sso/index.ts b/plugins/openid/routes/sso/index.ts index 7a982f9e..87c554ce 100644 --- a/plugins/openid/routes/sso/index.ts +++ b/plugins/openid/routes/sso/index.ts @@ -18,6 +18,7 @@ export default (plugin: PluginType): void => { method: "get", path: "/api/v1/sso", summary: "Get linked accounts", + tags: ["SSO"], middleware: [ auth({ auth: true, @@ -65,6 +66,7 @@ export default (plugin: PluginType): void => { method: "post", path: "/api/v1/sso", summary: "Link account", + tags: ["SSO"], middleware: [ auth({ auth: true,