Merge remote-tracking branch 'origin/main'

vrchatapi · Nov 7, 2024 · fb5ed3a · fb5ed3a
2 parents 558c0ca + 7f6f449
commit fb5ed3a
Show file tree

Hide file tree

Showing 45 changed files with 831 additions and 159 deletions.
diff --git a/openapi/components/codeSamples/economy.yaml b/openapi/components/codeSamples/economy.yaml
@@ -34,12 +34,6 @@
       source: >-
         curl -X GET "https://vrchat.com/api/1/subscriptions" \
              -b "auth={authCookie}"
-/licenseGroups:
-  get:
-    - lang: cURL
-      source: >-
-        curl -X GET "https://vrchat.com/api/1/licenseGroups" \
-             -b "auth={authCookie}"
 '/licenseGroups/{licenseGroupId}':
   get:
     - lang: cURL

diff --git a/openapi/components/codeSamples/instances.yaml b/openapi/components/codeSamples/instances.yaml
@@ -10,12 +10,6 @@
       source: >-
         curl -X GET "https://vrchat.com/api/1/instances/{worldId}:{instanceId}/shortName" \
              -b "auth={authCookie}"
-'/instance/{worldId}:{instanceId}/invite':
-  post:
-    - lang: cURL
-      source: >-
-        curl -X POST "https://vrchat.com/api/1/instances/{worldId}:{instanceId}/invite" \
-             -b "auth={authCookie}"
 '/instances/s/{shortname}':
   get:
     - lang: cURL

diff --git a/openapi/components/codeSamples/jams.yaml b/openapi/components/codeSamples/jams.yaml
@@ -0,0 +1,15 @@
+/jams:
+  get:
+    - lang: cURL
+      source: >-
+        curl -X GET "https://vrchat.com/api/1/jams?type={string}"
+/jams/{jamId}:
+  get:
+    - lang: cURL
+      source: >-
+        curl -X GET "https://vrchat.com/api/1/jams/{jamId}"
+/jams/{jamId}/submissions:
+  get:
+    - lang: cURL
+      source: >-
+        curl -X GET "https://vrchat.com/api/1/jams/{jamId}/submissions"
diff --git a/openapi/components/codeSamples/notifications.yaml b/openapi/components/codeSamples/notifications.yaml
@@ -4,6 +4,12 @@
       source: >-
         curl -X GET "https://vrchat.com/api/1/auth/user/notifications?type=all" \
              -b "auth={authCookie}"
+/auth/user/notifications/{notificationId}:
+  get:
+    - lang: cURL
+      source: >-
+        curl -X GET "https://vrchat.com/api/1/auth/user/notifications/{notificationId}" \
+             -b "auth={authCookie}"
 '/auth/user/notifications/{notificationId}/accept':
   put:
     - lang: cURL

diff --git a/openapi/components/codeSamples/playermoderation.yaml b/openapi/components/codeSamples/playermoderation.yaml
@@ -16,17 +16,6 @@
       source: >-
         curl -X DELETE "https://vrchat.com/api/1/auth/user/playermoderations" \
              -b "auth={authCookie}"
-'/auth/user/playermoderations/{playerModerationId}':
-  get:
-    - lang: cURL
-      source: >-
-        curl -X GET "https://vrchat.com/api/1/auth/user/playermoderations/{playerModerationId}" \
-             -b "auth={authCookie}"
-  delete:
-    - lang: cURL
-      source: >-
-        curl -X DELETE "https://vrchat.com/api/1/auth/user/playermoderations/{playerModerationId}" \
-             -b "auth={authCookie}"
 /auth/user/unplayermoderate:
   put:
     - lang: cURL

diff --git a/openapi/components/parameters.yaml b/openapi/components/parameters.yaml
@@ -363,4 +363,12 @@ fuzzy:
   in: query
   required: false
   schema:
-    type: boolean
+    type: boolean
+jamId:
+  name: jamId
+  in: path
+  required: true
+  schema:
+    type: string
+    example: jam_0b7e3f6d-4647-4648-b2a1-1431e76906d9
+  description: Must be a valid query ID.
diff --git a/openapi/components/paths.yaml b/openapi/components/paths.yaml
@@ -50,8 +50,6 @@
   $ref: "./paths/economy.yaml#/paths/~1auth~1user~1subscription"
 '/subscriptions':
   $ref: "./paths/economy.yaml#/paths/~1subscriptions"
-'/licenseGroups':
-  $ref: "./paths/economy.yaml#/paths/~1licenseGroups"
 '/licenseGroups/{licenseGroupId}':
   $ref: "./paths/economy.yaml#/paths/~1licenseGroups~1{licenseGroupId}"
 
@@ -170,15 +168,15 @@
   $ref: "./paths/instances.yaml#/paths/~1instances~1{worldId}:{instanceId}"
 "/instances/{worldId}:{instanceId}/shortName":
   $ref: "./paths/instances.yaml#/paths/~1instances~1{worldId}:{instanceId}~1shortName"
-"/instances/{worldId}:{instanceId}/invite":
-  $ref: "./paths/instances.yaml#/paths/~1instances~1{worldId}:{instanceId}~1invite"
 "/instances/s/{shortName}":
   $ref: "./paths/instances.yaml#/paths/~1instances~1s~1{shortName}"
 
 # notifications
 
 "/auth/user/notifications":
   $ref: "./paths/notifications.yaml#/paths/~1auth~1user~1notifications"
+"/auth/user/notifications/{notificationId}":
+  $ref: "./paths/notifications.yaml#/paths/~1auth~1user~1notifications~1{notificationId}"
 "/auth/user/notifications/{notificationId}/accept":
   $ref: "./paths/notifications.yaml#/paths/~1auth~1user~1notifications~1{notificationId}~1accept"
 "/auth/user/notifications/{notificationId}/see":
@@ -201,8 +199,6 @@
 
 "/auth/user/playermoderations":
   $ref: "./paths/playermoderation.yaml#/paths/~1auth~1user~1playermoderations"
-"/auth/user/playermoderations/{playerModerationId}":
-  $ref: "./paths/playermoderation.yaml#/paths/~1auth~1user~1playermoderations~1{playerModerationId}"
 "/auth/user/unplayermoderate":
   $ref: "./paths/playermoderation.yaml#/paths/~1auth~1user~1unplayermoderate"
 
@@ -223,6 +219,15 @@
 "/time":
   $ref: "./paths/system.yaml#/paths/~1time"
 
+# jams
+
+"/jams":
+  $ref: "./paths/jams.yaml#/paths/~1jams"
+"/jams/{jamId}":
+  $ref: "./paths/jams.yaml#/paths/~1jams~1{jamId}"
+"/jams/{jamId}/submissions":
+  $ref: "./paths/jams.yaml#/paths/~1jams~1{jamId}~1submissions"
+
 # users
 
 "/users":

diff --git a/openapi/components/paths/economy.yaml b/openapi/components/paths/economy.yaml
@@ -108,26 +108,6 @@ paths:
       tags:
         - economy
       description: 'List all existing Subscriptions. For example, "vrchatplus-monthly" and "vrchatplus-yearly".'
-  /licenseGroups:
-    get:
-      summary: List License Groups
-      operationId: getLicenseGroups
-      security:
-        - authCookie: []
-      x-codeSamples:
-        $ref: "../codeSamples/economy.yaml#/~1licenseGroups/get"
-      responses:
-        '200':
-          $ref: ../responses/economy/LicenseGroupListResponse.yaml
-        '401':
-          $ref: ../responses/MissingCredentialsError.yaml
-      tags:
-        - economy
-      description: |-
-        List all existing license groups.
-
-        **IMPLEMENTATION WARNING:** This endpoint currently return a text/plain array of seven nulls.
-      x-internal: true
   '/licenseGroups/{licenseGroupId}':
     parameters:
       - $ref: ../parameters.yaml#/licenseGroupId

diff --git a/openapi/components/paths/instances.yaml b/openapi/components/paths/instances.yaml
@@ -100,25 +100,6 @@ paths:
           $ref: ../responses/instances/InstanceShortNameResponse.yaml
         '401':
           $ref: ../responses/MissingCredentialsError.yaml
-  '/instances/{worldId}:{instanceId}/invite':
-    parameters:
-      - $ref: ../parameters.yaml#/worldId
-      - $ref: ../parameters.yaml#/instanceId
-    post:
-      summary: Send Self Invite
-      tags:
-        - instances
-      operationId: sendSelfInvite
-      security:
-        - authCookie: []
-      description: Sends an invite to the instance to yourself.
-      x-codeSamples:
-        $ref: "../codeSamples/instances.yaml#/~1instance~1{worldId}:{instanceId}~1invite/post"
-      responses:
-        '200':
-          $ref: ../responses/instances/InstanceSelfInviteSuccess.yaml
-        '401':
-          $ref: ../responses/MissingCredentialsError.yaml
   '/instances/s/{shortName}':
     parameters:
       - schema:

diff --git a/openapi/components/paths/jams.yaml b/openapi/components/paths/jams.yaml
@@ -0,0 +1,69 @@
+openapi: 3.0.3
+info:
+  title: jams
+  version: '1.0'
+  description: Jams Docs Here
+paths:
+  /jams:
+    get:
+      summary: Show jams list
+      tags:
+        - jams
+      x-codeSamples:
+        $ref: "../codeSamples/jams.yaml#/~1jams/get"
+      responses:
+        '200':
+          $ref: ../responses/jams/JamListResponse.yaml
+      security:
+        - authCookie: []
+      operationId: getJams
+      description: |-
+        Lists World Jams or Avatar Jams, both currently running and ones that have ended.
+        
+        `isActive` is used to select only active or already ended jams.
+        
+        `type` is used to select only world or avatar jams, and can only take `world` or `avatar`.
+        ``
+      parameters:
+        - schema:
+            type: string
+            example: avatar
+          in: query
+          name: type
+          description: 'Only show jams of this type (`avatar` or `world`).'
+  /jams/{jamId}:
+    parameters:
+      - $ref: ../parameters.yaml#/jamId
+    get:
+      summary: Show jam information
+      tags:
+        - jams
+      x-codeSamples:
+        $ref: "../codeSamples/jams.yaml#/~1jams~1{jamId}/get"
+      responses:
+        '200':
+          $ref: ../responses/jams/JamResponse.yaml
+        '404':
+          $ref: ../responses/jams/JamNotFoundError.yaml
+      security:
+        - authCookie: []
+      operationId: getJam
+      description: Returns a jam.
+  /jams/{jamId}/submissions:
+    parameters:
+      - $ref: ../parameters.yaml#/jamId
+    get:
+      summary: Show jam submissions
+      tags:
+        - jams
+      x-codeSamples:
+        $ref: "../codeSamples/jams.yaml#/~1jams~1{jamId}~1submissions/get"
+      responses:
+        '200':
+          $ref: ../responses/jams/SubmissionListResponse.yaml
+        '404':
+          $ref: ../responses/jams/JamNotFoundError.yaml
+      security:
+        - authCookie: []
+      operationId: getJamSubmissions
+      description: Returns all submissions of a jam.
diff --git a/openapi/components/paths/notifications.yaml b/openapi/components/paths/notifications.yaml
@@ -47,6 +47,26 @@ paths:
           description: Only return notifications sent after this Date. Ignored if type is `friendRequest`.
         - $ref: ../parameters.yaml#/number
         - $ref: ../parameters.yaml#/offset
+  '/auth/user/notifications/{notificationId}':
+    parameters:
+      - $ref: ../parameters.yaml#/notificationId
+    get:
+      summary: Show notification
+      operationId: getNotification
+      tags:
+        - notifications
+      x-codeSamples:
+        $ref: "../codeSamples/notifications.yaml#/~1auth~1user~1notifications~1{notificationId}/get"
+      responses:
+        '200':
+          $ref: ../responses/notifications/NotificationResponse.yaml
+        '401':
+          $ref: ../responses/MissingCredentialsError.yaml
+        '404':
+          $ref: ../responses/notifications/NotificationNotFoundError.yaml
+      security:
+        - authCookie: []
+      description: Get a notification by notification `not_` ID.
   '/auth/user/notifications/{notificationId}/see':
     parameters:
       - $ref: ../parameters.yaml#/notificationId

diff --git a/openapi/components/paths/playermoderation.yaml b/openapi/components/paths/playermoderation.yaml
@@ -133,48 +133,6 @@ paths:
           $ref: ../responses/MissingCredentialsError.yaml
       tags:
         - playermoderation
-  '/auth/user/playermoderations/{playerModerationId}':
-    parameters:
-      - schema:
-          type: string
-        name: playerModerationId
-        in: path
-        required: true
-        description: 'Must be a valid `pmod_` ID.'
-    get:
-      summary: Get Player Moderation
-      tags:
-        - playermoderation
-      x-codeSamples:
-        $ref: "../codeSamples/playermoderation.yaml#/~1auth~1user~1playermoderations~1{playerModerationId}/get"
-      responses:
-        '200':
-          $ref: ../responses/playermoderation/PlayerModerationResponse.yaml
-        '401':
-          $ref: ../responses/MissingCredentialsError.yaml
-        '404':
-          $ref: ../responses/playermoderation/PlayerModerationNotFoundError.yaml
-      operationId: getPlayerModeration
-      security:
-        - authCookie: []
-      description: Returns a single Player Moderation. This returns the exact same amount of information as the more generalised `getPlayerModerations`.
-    delete:
-      summary: Delete Player Moderation
-      operationId: deletePlayerModeration
-      security:
-        - authCookie: []
-      x-codeSamples:
-        $ref: "../codeSamples/playermoderation.yaml#/~1auth~1user~1playermoderations~1{playerModerationId}/delete"
-      responses:
-        '200':
-          $ref: ../responses/playermoderation/PlayerModerationRemovedSuccess.yaml
-        '401':
-          $ref: ../responses/MissingCredentialsError.yaml
-        '403':
-          $ref: ../responses/playermoderation/PlayerModerationDeleteOthersError.yaml
-      description: Deletes a specific player moderation based on it's `pmod_` ID. The website uses `unmoderateUser` instead. You can delete the same player moderation multiple times successfully.
-      tags:
-        - playermoderation
 tags:
   $ref: ../tags.yaml
 components:

diff --git a/openapi/components/paths/worlds.yaml b/openapi/components/paths/worlds.yaml
@@ -134,7 +134,7 @@ paths:
         $ref: "../codeSamples/worlds.yaml#/~1worlds~1favorites/get"
       responses:
         '200':
-          $ref: ../responses/worlds/LimitedWorldListResponse.yaml
+          $ref: ../responses/worlds/FavoritedWorldListResponse.yaml
         '401':
           $ref: ../responses/MissingCredentialsError.yaml
         '403':

diff --git a/openapi/components/responses/economy/LicenseGroupListResponse.yaml b/openapi/components/responses/economy/LicenseGroupListResponse.yaml
diff --git a/openapi/components/responses/instances/InstanceSelfInviteSuccess.yaml b/openapi/components/responses/instances/InstanceSelfInviteSuccess.yaml
diff --git a/openapi/components/responses/instances/InstanceShortNameResponse.yaml b/openapi/components/responses/instances/InstanceShortNameResponse.yaml
@@ -1,5 +1,5 @@
 description: Returns an instance secureName and/or shortName.
 content:
-  text/plain:
+  application/json:
     schema:
       $ref: ../../schemas/InstanceShortNameResponse.yaml
diff --git a/openapi/components/responses/jams/JamListResponse.yaml b/openapi/components/responses/jams/JamListResponse.yaml
@@ -0,0 +1,7 @@
+description: Returns a list of Jam objects.
+content:
+  application/json:
+    schema:
+      type: array
+      items:
+        $ref: ../../schemas/Jam.yaml