Remove all regex patterns and Update API Fields (#264)

* Update InstanceID, WorldID regex * Remove all regex patterns from schemas * Remove regex patterns from parameters * Add missing params to CurrentUser * Update UnityPackage * Update World and LimitedWorld (Add UdonProductId) * Remove last regex patterns --------- Co-authored-by: JU5TDIE <[email protected]>
vrchatapi · Dec 27, 2023 · 46aaca8 · 46aaca8
1 parent 6484025
commit 46aaca8
Show file tree

Hide file tree

Showing 31 changed files with 40 additions and 36 deletions.
diff --git a/openapi/components/parameters.yaml b/openapi/components/parameters.yaml
@@ -67,7 +67,6 @@ fileId:
   schema:
     type: string
     example: file_00000000-0000-0000-0000-000000000000
-    pattern: 'file_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
   description: Must be a valid file ID.
 groupId:
   name: groupId
@@ -76,7 +75,6 @@ groupId:
   schema:
     type: string
     example: grp_00000000-0000-0000-0000-000000000000
-    pattern: 'grp_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
   description: Must be a valid group ID.
 groupRoleId:
   name: groupRoleId
@@ -85,7 +83,6 @@ groupRoleId:
   schema:
     type: string
     example: grol_00000000-0000-0000-0000-000000000000
-    pattern: 'grol_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
   description: Must be a valid group role ID.
 groupGalleryId:
   name: groupGalleryId
@@ -94,7 +91,6 @@ groupGalleryId:
   schema:
     type: string
     example: ggal_00000000-0000-0000-0000-000000000000
-    pattern: 'ggal_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
   description: Must be a valid group gallery ID.
 groupGalleryImageId:
   name: groupGalleryImageId
@@ -103,7 +99,6 @@ groupGalleryImageId:
   schema:
     type: string
     example: ggim_00000000-0000-0000-0000-000000000000
-    pattern: 'ggim_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
   description: Must be a valid group gallery image ID.
 versionId:
   name: versionId

diff --git a/openapi/components/requests/FinishFileDataUploadRequest.yaml b/openapi/components/requests/FinishFileDataUploadRequest.yaml
@@ -17,7 +17,6 @@ properties:
     deprecated: true
     description: 'Always a zero in string form, despite how many parts uploaded.'
     maxLength: 1
-    pattern: '0'
   maxParts:
     type: string
     minLength: 1
@@ -26,7 +25,6 @@ properties:
     default: '0'
     example: '0'
     maxLength: 1
-    pattern: '0'
 required:
   - nextPartNumber
   - maxParts
diff --git a/openapi/components/schemas/AvatarID.yaml b/openapi/components/schemas/AvatarID.yaml
@@ -1,4 +1,3 @@
 example: avtr_912d66a4-4714-43b8-8407-7de2cafbf55b
-pattern: 'avtr_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: AvatarID
 type: string
diff --git a/openapi/components/schemas/CurrentUser.yaml b/openapi/components/schemas/CurrentUser.yaml
@@ -39,6 +39,10 @@ properties:
     $ref: ./CurrentAvatarImageUrl.yaml
   currentAvatarThumbnailImageUrl:
     $ref: ./CurrentAvatarThumbnailImageUrl.yaml
+  currentAvatarTags:
+    type: array
+    items:
+      $ref: ./Tag.yaml
   date_joined:
     format: date
     type: string
@@ -64,6 +68,14 @@ properties:
     type: array
   hasBirthday:
     type: boolean
+  hideContentFilterSettings:
+    type: boolean
+  userLanguage:
+    nullable: true
+    type: string
+  userLanguageCode:
+    nullable: true
+    type: string
   hasEmail:
     type: boolean
   hasLoggedInFromClient:
@@ -91,6 +103,12 @@ properties:
     type: string
   oculusId:
     type: string
+  googleId:
+    type: string
+  picoId:
+    type: string
+  viveId:
+    type: string
   offlineFriends:
     items:
       $ref: ./UserID.yaml

diff --git a/openapi/components/schemas/FavoriteGroupID.yaml b/openapi/components/schemas/FavoriteGroupID.yaml
@@ -1,4 +1,3 @@
 example: fvgrp_8a02a44b-dc3a-4a9a-bc77-77fa37996fc7
-pattern: 'fvgrp_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: FavoriteGroupID
 type: string
diff --git a/openapi/components/schemas/FavoriteID.yaml b/openapi/components/schemas/FavoriteID.yaml
@@ -1,4 +1,3 @@
 example: fvrt_9568d189-8776-44a5-a8c8-defc981e44de
-pattern: 'fvrt_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: FavoriteID
 type: string
diff --git a/openapi/components/schemas/FileID.yaml b/openapi/components/schemas/FileID.yaml
@@ -1,4 +1,3 @@
 example: file_ce35d830-e20a-4df0-a6d4-5aaef4508044
-pattern: 'file_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: FileID
 type: string
diff --git a/openapi/components/schemas/GroupAnnouncementID.yaml b/openapi/components/schemas/GroupAnnouncementID.yaml
@@ -1,4 +1,3 @@
 example: gpos_71a7ff59-112c-4e78-a990-c7cc650776e5
-pattern: 'gpos_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupAnnouncementID
 type: string
diff --git a/openapi/components/schemas/GroupAuditLogID.yaml b/openapi/components/schemas/GroupAuditLogID.yaml
@@ -1,4 +1,3 @@
 example: gaud_71a7ff59-112c-4e78-a990-c7cc650776e5
-pattern: 'gaud_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupAuditLogID
 type: string
diff --git a/openapi/components/schemas/GroupDiscriminator.yaml b/openapi/components/schemas/GroupDiscriminator.yaml
@@ -1,4 +1,3 @@
 example: '1234'
-pattern: '^[0-9]{4}$'
 title: GroupDiscriminator
 type: string
diff --git a/openapi/components/schemas/GroupGalleryID.yaml b/openapi/components/schemas/GroupGalleryID.yaml
@@ -1,4 +1,3 @@
 example: ggal_a03a4b55-4ca6-4490-9519-40ba6351a233
-pattern: 'ggal_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupGalleryID
 type: string
diff --git a/openapi/components/schemas/GroupGalleryImageID.yaml b/openapi/components/schemas/GroupGalleryImageID.yaml
@@ -1,4 +1,3 @@
 example: ggim_71a7ff59-112c-4e78-a990-c7cc650776e5
-pattern: 'ggim_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupGalleryImageID
 type: string
diff --git a/openapi/components/schemas/GroupID.yaml b/openapi/components/schemas/GroupID.yaml
@@ -1,4 +1,3 @@
 example: grp_71a7ff59-112c-4e78-a990-c7cc650776e5
-pattern: 'grp_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupID
 type: string
diff --git a/openapi/components/schemas/GroupMemberID.yaml b/openapi/components/schemas/GroupMemberID.yaml
@@ -1,4 +1,3 @@
 example: gmem_95cdb3b4-4643-4eb6-bdab-46a4e1e5ce37
-pattern: 'gmem_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupMemberID
 type: string
diff --git a/openapi/components/schemas/GroupRoleID.yaml b/openapi/components/schemas/GroupRoleID.yaml
@@ -1,4 +1,3 @@
 example: grol_459d3911-f672-44bc-b84d-e54ffe7960fe
-pattern: 'grol_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: GroupRoleID
 type: string
diff --git a/openapi/components/schemas/GroupShortCode.yaml b/openapi/components/schemas/GroupShortCode.yaml
@@ -1,4 +1,3 @@
 example: ABC123
-pattern: '^[A-Z0-9]{3,6}$'
 title: GroupShortCode
 type: string
diff --git a/openapi/components/schemas/InstanceID.yaml b/openapi/components/schemas/InstanceID.yaml
@@ -1,5 +1,4 @@
 type: string
-example: 'wrld_ba913a96-fac4-4048-a062-9aa5db092812:12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)'
-pattern: '(private|offline|(wrld|wld)_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}:(\d+)(~region\(([\w]+)\))?(~([\w]+)\(usr_([\w-]+)\)((\~canRequestInvite)?)(~region\(([\w].+)\))?~nonce\((.+)\))?)'
+example: '12345~hidden(usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469)~region(eu)~nonce(27e8414a-59a0-4f3d-af1f-f27557eb49a2)'
 title: InstanceID
 description: InstanceID can be "offline" on User profiles if you are not friends with that user and "private" if you are friends and user is in private instance.
diff --git a/openapi/components/schemas/InviteMessageID.yaml b/openapi/components/schemas/InviteMessageID.yaml
@@ -1,4 +1,3 @@
 example: invm_24a1c14d-5e24-48e5-90e3-c3f712420ffa
-pattern: '(default|invm_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})'
 title: InviteMessageID
 type: string
diff --git a/openapi/components/schemas/License.yaml b/openapi/components/schemas/License.yaml
@@ -5,7 +5,6 @@ properties:
     type: string
     description: 'Either a AvatarID, LicenseGroupID, PermissionID or ProductID. This depends on the `forType` field.'
     minLength: 1
-    pattern: '(avtr|lgrp|prms|prod)_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
   forType:
     $ref: ./LicenseType.yaml
   forName:

diff --git a/openapi/components/schemas/LicenseGroupID.yaml b/openapi/components/schemas/LicenseGroupID.yaml
@@ -1,4 +1,3 @@
 example: lgrp_608513da-b213-4e15-80af-bd88c27f0979
-pattern: 'lgrp_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: LicenseGroupID
 type: string
diff --git a/openapi/components/schemas/LimitedWorld.yaml b/openapi/components/schemas/LimitedWorld.yaml
@@ -7,8 +7,9 @@ properties:
     type: string
   capacity:
     example: 8
-    maximum: 40
-    minimum: 0
+    type: integer
+  recommendedCapacity:
+    example: 16
     type: integer
   created_at:
     format: date-time
@@ -72,6 +73,10 @@ properties:
   updated_at:
     format: date-time
     type: string
+  udonProducts:
+    type: array
+    items:
+      $ref: ./UdonProductId.yaml
 required:
   - id
   - name

diff --git a/openapi/components/schemas/NotificationID.yaml b/openapi/components/schemas/NotificationID.yaml
@@ -1,4 +1,3 @@
 example: not_00000000-0000-0000-0000-000000000000
-pattern: '(not|frq)_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: NotificationID
 type: string
diff --git a/openapi/components/schemas/PermissionID.yaml b/openapi/components/schemas/PermissionID.yaml
@@ -1,4 +1,3 @@
 example: prms_804ba021-9f47-4e25-9847-1f42fdb2e6ff
-pattern: 'prms_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: PermissionID
 type: string
diff --git a/openapi/components/schemas/PlayerModerationID.yaml b/openapi/components/schemas/PlayerModerationID.yaml
@@ -1,4 +1,3 @@
 example: pmod_25551a8d-6f5d-430a-88d3-9c0ce08b5244
-pattern: 'pmod_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: PlayerModerationID
 type: string
diff --git a/openapi/components/schemas/ProductID.yaml b/openapi/components/schemas/ProductID.yaml
@@ -1,4 +1,3 @@
 example: prod_bfbc2315-247a-44d7-bfea-5237f8d56cb4
-pattern: 'prod_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: ProductID
 type: string
diff --git a/openapi/components/schemas/TransactionID.yaml b/openapi/components/schemas/TransactionID.yaml
@@ -1,4 +1,3 @@
 example: txn_e5c72948-e735-4880-8245-24b2a41198b0
-pattern: 'txn_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: TransactionID
 type: string
diff --git a/openapi/components/schemas/UdonProductId.yaml b/openapi/components/schemas/UdonProductId.yaml
@@ -0,0 +1,4 @@
+example: prod_c1644b5b-3ca4-45b4-97c6-a2a0de70d469
+title: UdonProductId
+type: string
+description: 'A unique ID of a Udon Product'
diff --git a/openapi/components/schemas/UnityPackage.yaml b/openapi/components/schemas/UnityPackage.yaml
@@ -11,6 +11,8 @@ example:
   unitySortNumber: 20180414000
   unityVersion: 2018.4.14f1
 properties:
+  id:
+    $ref: ./UnityPackageID.yaml
   assetUrl:
     minLength: 1
     type: string
@@ -22,8 +24,6 @@ properties:
   created_at:
     format: date-time
     type: string
-  id:
-    $ref: ./UnityPackageID.yaml
   platform:
     $ref: ./Platform.yaml
   pluginUrl:
@@ -39,6 +39,10 @@ properties:
     example: 2018.4.12f1
     minLength: 1
     type: string
+  impostorUrl:
+    type: string
+  scanStatus:
+    type: string
 required:
   - id
   - unityVersion

diff --git a/openapi/components/schemas/UnityPackageID.yaml b/openapi/components/schemas/UnityPackageID.yaml
@@ -1,4 +1,3 @@
 example: unp_52b12c39-4163-457d-a4a9-630e7aff1bff
-pattern: '(unp)_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}'
 title: UnityPackageID
 type: string
diff --git a/openapi/components/schemas/World.yaml b/openapi/components/schemas/World.yaml
@@ -116,6 +116,10 @@ properties:
     example: 9988675
     minimum: 0
     type: integer
+  udonProducts:
+    type: array
+    items:
+      $ref: ./UdonProductId.yaml
 required:
   - authorId
   - authorName

diff --git a/openapi/components/schemas/WorldID.yaml b/openapi/components/schemas/WorldID.yaml
@@ -1,5 +1,4 @@
 example: wrld_ba913a96-fac4-4048-a062-9aa5db092812
-pattern: '(^$|offline|(wrld|wld)_[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})'
 title: WorldID
 type: string
 description: WorldID be "offline" on User profiles if you are not friends with that user.