feat: enhance API documentation with authentication requirements and new update endpoints

Author: JustYuuto

docs/endpoints/cards.md

@@ -5,6 +5,12 @@ sidebar_position: 2
 
 This page contains information about the `/cards` endpoint, which is used to manage your cards.
 
+:::info
+
+This endpoint requires authentication and the [`cards` scope](/oauth2/scopes#cards).
+
+:::
+
 ## Get a card
 
 Get a card by its ID.

docs/endpoints/links.md

@@ -5,6 +5,12 @@ sidebar_position: 3
 
 This page contains information about the `/links` endpoint, which is used to manage your links.
 
+:::info
+
+This endpoint requires authentication and the [`links` scope](/oauth2/scopes#links).
+
+:::
+
 ## Get a link
 
 Get a link by its ID.
@@ -58,6 +64,38 @@ Returns a 201 status on success, and the link object in the response body.
 }
 ```
 
+## Update a link
+
+Update a link by its ID.
+
+### Request
+
+`:id` is the ID of the link you want to update.
+
+```http request
+PATCH /api/links/:id
+Content-Type: application/json
+```
+
+Example body:
+```json
+{
+  "value": "id/Yuuto"
+}
+```
+
+### Example Response
+
+Returns a 200 status on success, and the updated link object in the response body.
+
+```json
+{
+  "id": "5675e563-0fd3-419b-947f-d95e507f673b",
+  "type": "steam",
+  "value": "id/Yuuto"
+}
+```
+
 ## Delete a link
 
 Delete a link by its ID.

docs/endpoints/uploads.md

@@ -5,6 +5,12 @@ sidebar_position: 4
 
 This page contains information about the `/upload` endpoint, which is used to upload avatars, backgrounds, audios, custom cursors, and custom fonts.
 
+:::info
+
+Those endpoints requires authentication and the [`uploads` scope](/oauth2/scopes#uploads).
+
+:::
+
 ## Upload an avatar
 
 Upload a new avatar, and replace the current one if you have one.
@@ -99,6 +105,12 @@ Covers URLs are just `https://cdn.miwa.lol/audios-covers/:id.png`, where `:id` i
 
 ## Update an audio
 
+:::info
+
+This endpoint requires the [`audios.manage`](/oauth2/scopes#audios.manage) scope.
+
+:::
+
 Update an audio by its ID.
 
 ### Request
@@ -131,6 +143,12 @@ Returns the updated audio object.
 
 ## Delete an audio
 
+:::info
+
+This endpoint requires the [`audios.manage`](/oauth2/scopes#audios.manage) scope.
+
+:::
+
 Delete an audio by its ID.
 
 ### Request

docs/endpoints/users.md

@@ -86,6 +86,12 @@ GET /api/user/:username
 
 ## Get your user
 
+:::info
+
+This endpoint requires authentication and the [`identify` scope](/oauth2/scopes#identify). If you want to get the user's email address, you will also need the [`email` scope](/oauth2/scopes#email).
+
+:::
+
 Get the user that is currently authenticated.
 
 ### Request
@@ -168,6 +174,12 @@ This is practically the same as the response from the previous endpoint, but wit
 
 ## Update your profile
 
+:::info
+
+This endpoint requires authentication and the [`profile.update` scope](/oauth2/scopes#profileupdate).
+
+:::
+
 Allows you to update your profile, including your username, display name, alias, bio, and more.
 
 ### Request

docs/oauth2/scopes.md

@@ -14,17 +14,21 @@ Grants access to the user's information, such as their username, display name, a
 
 Grants access to the user's email address.
 
+### `profile.update`
+
+Grants ability to update the user's profile, such as their username, display name, colors, effects, etc.
+
 ### `links`
 
 Grants access to the user's links and the ability to create, update, and delete them.
 
 ### `cards`
 
-Grants access to the user's cards and the ability to create, update, and delete them.
+Grants access to the user's cards and the ability to create and delete them.
 
 ### `audios.manage`
 
-Grants ability to create, update, and delete audios.
+Grants ability to update and delete audios. For uploading audios, you need the `uploads` scope.
 
 ### `uploads`