Add User Group Instances endpoint

openapi/components/codeSamples/users.yaml

@@ -54,3 +54,9 @@
       source: >-
         curl -X GET "https://api.vrchat.cloud/api/1/userNotes/{userNoteId}" \
              -b "auth={authCookie}"
+'/users/{userId}/instances/groups':
+  get:
+    - lang: cURL
+      source: >-
+        curl -X GET "https://api.vrchat.cloud/api/1/users/{userId}/instances/groups" \
+             -b "auth={authCookie}"

openapi/components/paths.yaml

@@ -270,6 +270,8 @@
   $ref: "./paths/users.yaml#/paths/~1userNotes"
 "/userNotes/{userNoteId}":
   $ref: "./paths/users.yaml#/paths/~1userNotes~1{userNoteId}"
+"/users/{userId}/instances/groups":
+  $ref: "./paths/users.yaml#/paths/~1users~1{userId}~1instances~1groups"
 
 # worlds
 

openapi/components/paths/users.yaml

@@ -274,6 +274,26 @@ paths:
           $ref: ../responses/MissingCredentialsError.yaml
       operationId: getUserNote
       description: Get a particular user note
+  "/users/{userId}/instances/groups":
+    parameters:
+      - $ref: ../parameters.yaml#/userId
+    get:
+      summary: Get User Group Instances
+      x-codeSamples:
+        $ref: ../codeSamples/users.yaml#/~1users~1{userId}~1instances~1groups/get
+      description: Returns a list of group instances for a user
+      operationId: getUserGroupInstances
+      tags:
+        - users
+      responses:
+        '200':
+          $ref: ../responses/users/UserGroupInstanceListResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+        '403':
+          $ref: ../responses/users/UserMustBeOwnError.yaml
+      security:
+        - authCookie: []
 tags:
   $ref: ../tags.yaml
 components:

openapi/components/responses/users/UserGroupInstanceListResponse.yaml

@@ -0,0 +1,13 @@
+description: Returns a list of Instance objects with a fetched at time.
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        fetchedAt:
+          type: string
+          format: date-time
+        instances:
+          type: array
+          items:
+            $ref: ../../schemas/Instance.yaml

openapi/components/responses/users/UserMustBeOwnError.yaml

@@ -0,0 +1,11 @@
+description: Error response when trying get group instances of another user.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/Error.yaml
+    examples:
+      User Id must be your own:
+        value:
+          error:
+            message: "User ID must be your own․"
+            status_code: 403