add summary to all openapi routes

wanderer-moe · Mar 17, 2024 · 57667af · 57667af
1 parent f870e28
commit 57667af
Show file tree

Hide file tree

Showing 35 changed files with 36 additions and 2 deletions.
diff --git a/src/openapi/config.ts b/src/openapi/config.ts
@@ -5,7 +5,7 @@ export const OpenAPIConfig: OpenAPIObjectConfig = {
     info: {
         version: "2.0.0",
         title: "api.wanderer.moe",
-        description: `Public Zod OpenAPI documentation for wanderer.moe's API. This API is used to power the website & all routes are documented.`,
+        description: `Public Zod OpenAPI documentation for wanderer.moe's API. This API is used to power the website & all routes are documented. Rate limits are imposed to prevent abuse.`,
         license: {
             name: "GNU General Public License v3.0",
             url: "https://www.gnu.org/licenses/gpl-3.0.en.html",

diff --git a/src/v2/routes/asset/delete-asset.ts b/src/v2/routes/asset/delete-asset.ts
@@ -25,6 +25,7 @@ const deleteAssetByIdResponseSchema = z.object({
 const deleteAssetByIdRoute = createRoute({
     path: "/{id}/delete",
     method: "delete",
+    summary: "Delete an asset",
     description:
         "Delete an asset from their ID. Must be the owner of the asset or an admin.",
     tags: ["Asset"],

diff --git a/src/v2/routes/asset/download-asset.ts b/src/v2/routes/asset/download-asset.ts
@@ -25,6 +25,7 @@ const downloadAssetByIdResponseSchema = z.object({
 const downloadAssetByIdRoute = createRoute({
     path: "/{id}/download",
     method: "get",
+    summary: "Download an asset",
     description: "Download an asset by their ID.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/get-asset-comments.ts b/src/v2/routes/asset/get-asset-comments.ts
@@ -52,6 +52,7 @@ const getAssetCommentsResponseSchema = z.object({
 const getAssetCommentsRoute = createRoute({
     path: "/{id}/comments",
     method: "get",
+    summary: "Get an asset's comments",
     description: "Get an asset's comments.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/get-asset.ts b/src/v2/routes/asset/get-asset.ts
@@ -73,6 +73,7 @@ const getAssetByIdResponseSchema = z.object({
 const getAssetByIdRoute = createRoute({
     path: "/{id}",
     method: "get",
+    summary: "Get an asset",
     description: "Get an asset by their ID.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/get-users-asset-likes.ts b/src/v2/routes/asset/get-users-asset-likes.ts
@@ -29,7 +29,8 @@ const allAssetLikesSchema = z.object({
 const allAssetLikesRoute = createRoute({
     path: "/likes",
     method: "get",
-    description: "All your liked assets.",
+    summary: "Your liked assets",
+    description: "List of all your liked assets.",
     tags: ["Asset"],
     responses: {
         200: {

diff --git a/src/v2/routes/asset/like-asset.ts b/src/v2/routes/asset/like-asset.ts
@@ -26,6 +26,7 @@ const likeAssetByIdResponseSchema = z.object({
 const likeAssetByIdRoute = createRoute({
     path: "/{id}/like",
     method: "post",
+    summary: "Like an asset",
     description: "Like an asset from their ID.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/modify-asset.ts b/src/v2/routes/asset/modify-asset.ts
@@ -59,6 +59,7 @@ const modifyAssetResponseSchema = z.object({
 const modifyAssetRoute = createRoute({
     path: "/{id}/modify",
     method: "patch",
+    summary: "Modify an asset",
     description: "Modify an existing asset.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/search-assets.ts b/src/v2/routes/asset/search-assets.ts
@@ -97,6 +97,7 @@ export type assetSearchAllFilter = z.infer<typeof assetSearchAllFilterSchema>
 const assetSearchAllFilterRoute = createRoute({
     path: "/search",
     method: "get",
+    summary: "Search for assets",
     description: "Filter all assets",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/unlike-asset.ts b/src/v2/routes/asset/unlike-asset.ts
@@ -26,6 +26,7 @@ const unlikeAssetByIdResponseSchema = z.object({
 const unlikeAssetByIdRoute = createRoute({
     path: "/{id}/unlike",
     method: "post",
+    summary: "Unlike an asset",
     description: "Unlike an asset from their ID.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/asset/upload-asset.ts b/src/v2/routes/asset/upload-asset.ts
@@ -65,6 +65,7 @@ const uploadAssetResponseSchema = z.object({
 const uploadAssetRoute = createRoute({
     path: "/upload",
     method: "post",
+    summary: "Upload an asset",
     description: "Upload a new asset.",
     tags: ["Asset"],
     request: {

diff --git a/src/v2/routes/auth/account-create.ts b/src/v2/routes/auth/account-create.ts
@@ -31,6 +31,7 @@ const createAccountResponseSchema = z.object({
 const userCreateAccountRoute = createRoute({
     path: "/create",
     method: "post",
+    summary: "Create a new account",
     description: "Create a new user account with an email and password.",
     tags: ["Auth"],
     request: {

diff --git a/src/v2/routes/auth/account-login.ts b/src/v2/routes/auth/account-login.ts
@@ -27,6 +27,7 @@ const loginResponseSchema = z.object({
 export const userLoginRoute = createRoute({
     path: "/login",
     method: "post",
+    summary: "Login",
     description: "Login to a user with an email and password.",
     tags: ["Auth"],
     request: {

diff --git a/src/v2/routes/auth/get-all-sessions.ts b/src/v2/routes/auth/get-all-sessions.ts
@@ -18,6 +18,7 @@ const sessionListSchema = z.object({
 const authAllCurrentSessions = createRoute({
     path: "/sessions",
     method: "get",
+    summary: "Get all current sessions",
     description: "Get all current sessions.",
     tags: ["Auth"],
     responses: {

diff --git a/src/v2/routes/auth/invalidate-session.ts b/src/v2/routes/auth/invalidate-session.ts
@@ -24,6 +24,7 @@ const invalidateSessionResponseSchema = z.object({
 const invalidateSessionRoute = createRoute({
     path: "/invalidate/{id}",
     method: "get",
+    summary: "Invalidate a session",
     description: "Invalidate a session by its ID.",
     tags: ["Auth"],
     request: {

diff --git a/src/v2/routes/auth/logout-current-session.ts b/src/v2/routes/auth/logout-current-session.ts
@@ -12,6 +12,7 @@ const logoutResponseSchema = z.object({
 const authLogoutRoute = createRoute({
     path: "/logout",
     method: "get",
+    summary: "Logout",
     description: "Logout current session.",
     tags: ["Auth"],
     responses: {

diff --git a/src/v2/routes/auth/validate-current-session.ts b/src/v2/routes/auth/validate-current-session.ts
@@ -13,6 +13,7 @@ const authValidationSchema = z.object({
 const authValidationRoute = createRoute({
     path: "/validate",
     method: "get",
+    summary: "Validate current session",
     description: "Validate current session.",
     tags: ["Auth"],
     responses: {

diff --git a/src/v2/routes/contributors/all-contributors.ts b/src/v2/routes/contributors/all-contributors.ts
@@ -24,6 +24,7 @@ const contributorListSchema = z.object({
 const contributorsRoute = createRoute({
     path: "/all",
     method: "get",
+    summary: "Get all contributors",
     description: "Get a list of all contributors.",
     tags: ["Contributors"],
     responses: {

diff --git a/src/v2/routes/game/all-games.ts b/src/v2/routes/game/all-games.ts
@@ -14,6 +14,7 @@ export const getAllGamesResponse = z.object({
 const getAllGamesRoute = createRoute({
     path: "/all",
     method: "get",
+    summary: "Get all games",
     description: "Get all games.",
     tags: ["Game"],
     responses: {

diff --git a/src/v2/routes/game/create-game.ts b/src/v2/routes/game/create-game.ts
@@ -38,6 +38,7 @@ export const createGameResponse = z.object({
 const createGameRoute = createRoute({
     path: "/create",
     method: "post",
+    summary: "Create a game",
     description: "Create a new game.",
     tags: ["Game"],
     request: {

diff --git a/src/v2/routes/game/delete-game.ts b/src/v2/routes/game/delete-game.ts
@@ -26,6 +26,7 @@ export const deleteGameResponse = z.object({
 const deleteGameRoute = createRoute({
     path: "/{id}/delete",
     method: "delete",
+    summary: "Delete a game",
     description: "Delete a game & all its related assets.",
     tags: ["Game"],
     request: {

diff --git a/src/v2/routes/game/get-game.ts b/src/v2/routes/game/get-game.ts
@@ -27,6 +27,7 @@ const getGameByIDResponse = z.object({
 const getGameByIdRoute = createRoute({
     path: "/{id}",
     method: "get",
+    summary: "Get a game",
     description: "Get a game by their ID.",
     tags: ["Game"],
     request: {

diff --git a/src/v2/routes/game/modify-game.ts b/src/v2/routes/game/modify-game.ts
@@ -50,6 +50,7 @@ const modifyGameResponseSchema = z.object({
 export const modifyGameRoute = createRoute({
     path: "/{id}/modify",
     method: "patch",
+    summary: "Modify a game",
     description: "Modify an existing game.",
     tags: ["Game"],
     request: {

diff --git a/src/v2/routes/requests/all-requests.ts b/src/v2/routes/requests/all-requests.ts
@@ -34,6 +34,7 @@ const viewAllRequestsResponseSchema = z.object({
 const getAllRequestsRoute = createRoute({
     path: "/all",
     method: "get",
+    summary: "Get all requests",
     description:
         "Get all requests & associated upvotes count. Supporter required.",
     tags: ["Requests"],

diff --git a/src/v2/routes/requests/create-request.ts b/src/v2/routes/requests/create-request.ts
@@ -36,6 +36,7 @@ const createRequestFormEntryResponse = z.object({
 const createRequestFormEntryRoute = createRoute({
     path: "/create",
     method: "post",
+    summary: "Create request entry",
     description:
         "Create a new entry into the request form. Supporter required.",
     tags: ["Requests"],

diff --git a/src/v2/routes/requests/delete-request.ts b/src/v2/routes/requests/delete-request.ts
@@ -26,6 +26,7 @@ export const deleteRequestByIdResponseSchema = z.object({
 const deleteRequestByIdRoute = createRoute({
     path: "/{id}/delete",
     method: "delete",
+    summary: "Delete a request",
     description:
         "Delete a request by its ID. This will also delete all associated upvotes.",
     tags: ["Requests"],

diff --git a/src/v2/routes/requests/remove-request-upvote.ts b/src/v2/routes/requests/remove-request-upvote.ts
@@ -26,6 +26,7 @@ export const removeRequestUpvoteByIdResponseSchema = z.object({
 const removeRequestUpvoteByIdRoute = createRoute({
     path: "/{id}/downvote",
     method: "post",
+    summary: "Remove upvote on a request",
     description: "Remove a upvote on a request by its ID. Supporter required.",
     tags: ["Requests"],
     request: {

diff --git a/src/v2/routes/requests/upvote-request.ts b/src/v2/routes/requests/upvote-request.ts
@@ -26,6 +26,7 @@ export const upvoteRequestByIdResponseSchema = z.object({
 const upvoteRequestByIdRoute = createRoute({
     path: "/{id}/upvote",
     method: "post",
+    summary: "Upvote a request",
     description: "Upvote a request by its ID. Supporter required.",
     tags: ["Requests"],
     request: {

diff --git a/src/v2/routes/requests/view-request.ts b/src/v2/routes/requests/view-request.ts
@@ -27,6 +27,7 @@ export const viewRequestByIdResponseSchema = z.object({
 const viewRequestByIdRoute = createRoute({
     path: "/{id}",
     method: "get",
+    summary: "View a request",
     description: "View a request by its ID. Supporter required.",
     tags: ["Requests"],
     request: {

diff --git a/src/v2/routes/user/follow-user.ts b/src/v2/routes/user/follow-user.ts
@@ -25,6 +25,7 @@ const followUserByIdResponseSchema = z.object({
 export const followUserByIdRoute = createRoute({
     path: "/{id}/follow",
     method: "post",
+    summary: "Follow a user",
     description: "Follow a user from their ID.",
     tags: ["User"],
     request: {

diff --git a/src/v2/routes/user/get-user.ts b/src/v2/routes/user/get-user.ts
@@ -38,6 +38,7 @@ const getUserByIdResponseSchema = z.object({
 const getUserByIdRoute = createRoute({
     path: "/{id}",
     method: "get",
+    summary: "Get a user",
     description: "Get a user by their ID.",
     tags: ["User"],
     request: {

diff --git a/src/v2/routes/user/search-users.ts b/src/v2/routes/user/search-users.ts
@@ -40,6 +40,7 @@ const searchUsersByUsernameSchema = z.object({
 const searchUsersByUsernameRoute = createRoute({
     path: "/search/{username}",
     method: "get",
+    summary: "Search for users",
     description: "Search for users by their username.",
     tags: ["User"],
     request: {

diff --git a/src/v2/routes/user/unfollow-user.ts b/src/v2/routes/user/unfollow-user.ts
@@ -25,6 +25,7 @@ const unfollowUserByIdResponseSchema = z.object({
 const unFollowUserByIdRoute = createRoute({
     path: "/{id}/unfollow",
     method: "post",
+    summary: "Unfollow a user",
     description: "Follow a user from their ID.",
     tags: ["User"],
     request: {

diff --git a/src/v2/routes/user/user-followers.ts b/src/v2/routes/user/user-followers.ts
@@ -49,6 +49,7 @@ export const viewUserFollowsbyIdResponseSchema = z.object({
 const viewUserFollowsByIdRoute = createRoute({
     path: "/{id}/followers",
     method: "get",
+    summary: "View a user's followers",
     description: "View a user's followers from their ID.",
     tags: ["User"],
     request: {

diff --git a/src/v2/routes/user/user-following.ts b/src/v2/routes/user/user-following.ts
@@ -49,6 +49,7 @@ const viewUserfollowingbyIdResponseSchema = z.object({
 const viewUserfollowingbyIdRoute = createRoute({
     path: "/{id}/following",
     method: "get",
+    summary: "View who a user's following",
     description: "View who a user's following from their ID.",
     tags: ["User"],
     request: {