feat(friends): document more friend endpoint error responses

Document more friend endpoint error responses
vrchatapi · Apr 15, 2024 · e08693f · e08693f
1 parent 3541a77
commit e08693f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/openapi/components/paths/friends.yaml b/openapi/components/paths/friends.yaml
@@ -58,6 +58,8 @@ paths:
       responses:
         '200':
           $ref: ../responses/notifications/NotificationResponse.yaml
+        '400':
+          $ref: ../responses/friends/FriendBadRequestError.yaml
         '401':
           $ref: ../responses/MissingCredentialsError.yaml
         '404':

diff --git a/openapi/components/responses/friends/FriendBadRequestError.yaml b/openapi/components/responses/friends/FriendBadRequestError.yaml
@@ -0,0 +1,16 @@
+description: Bad request error response when sending a friend request
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/Error.yaml
+    examples:
+      Users Already Friends:
+        value:
+          error:
+            message: Users are already friends
+            status_code: 400
+      Already Sent a Friend Request:
+        value:
+          error:
+            message: This user has already been sent a friend request
+            status_code: 400