feature(worlds): add worlds api

openapi/components/responses/CreateWorldNotAllowedYetError.yaml

@@ -0,0 +1,11 @@
+description: Error response when trying create a world without having the neccesary Trust rank yet.
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
+    examples:
+      400 Can't Create World Yet:
+        value:
+          error:
+            message: \"You can't create a world right now\"
+            status_code: 400

openapi/components/responses/SeeOtherUserFavoritesError.yaml

@@ -0,0 +1,11 @@
+description: Error response when trying to see favourites of another user without sufficient admin permissions.
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
+    examples:
+      404 Cant See Other Users Favorites:
+        value:
+          error:
+            message: 403 You can't see another user's favorites
+            status_code: 403

openapi/components/responses/SeeOtherUserRecentsError.yaml

@@ -0,0 +1,11 @@
+description: Error response when trying to accept a see recently visited worlds of another user without sufficient admin permissions.
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
+    examples:
+      403 Only See Own Recents:
+        value:
+          error:
+            message: \"You can only see your own recent worlds!\"
+            status_code: 403

openapi/components/responses/WorldNotFoundError.yaml

@@ -0,0 +1,11 @@
+description: Error response when trying to show information about a non-existent world. Sometimes returns with `model <worldId> not found` instead of `World <worldId not found`.
+content:
+  application/json:
+    schema:
+      $ref: ../schemas/Error.yaml
+    examples:
+      404 World Not Found:
+        value:
+          error:
+            message: World wrld_ba913a96-fac4-4048-a062-9aa5db092812 not found
+            status_code: 404

openapi/components/schemas/CurrentUser.yaml

@@ -90,7 +90,7 @@ properties:
     type: string
     format: date-time
   last_platform:
-    type: string
+    $ref: ./Platform.yaml
   allowAvatarCopying:
     type: boolean
   status:
@@ -142,8 +142,6 @@ required:
   - fallbackAvatar
   - currentAvatar
   - currentAvatarAssetUrl
-# Note: This is technically required, but does not generate as nullable if marked as required
-# - accountDeletionDate
   - acceptedTOSVersion
   - steamId
   - steamDetails

openapi/components/schemas/LimitedUnityPackage.yaml

@@ -0,0 +1,13 @@
+description: ''
+type: object
+title: LimitedUnityPackage
+properties:
+  platform:
+    $ref: ./Platform.yaml
+  unityVersion:
+    type: string
+    minLength: 1
+    example: 2018.4.14f1
+required:
+  - platform
+  - unityVersion

openapi/components/schemas/LimitedUser.yaml

@@ -24,7 +24,7 @@ properties:
   developerType:
     $ref: ./DeveloperType.yaml
   last_platform:
-    type: string
+    $ref: ./Platform.yaml
   status:
     $ref: ./UserStatus.yaml
   isFriend:

openapi/components/schemas/LimitedWorld.yaml

@@ -1,72 +1,78 @@
-title: LimitedWorld
+description: ''
 type: object
 properties:
+  id:
+    $ref: ./WorldID.yaml
+  name:
+    type: string
+    minLength: 1
   authorId:
-    $ref: ./UserID.yaml
+    type: string
+    minLength: 1
   authorName:
     type: string
+    minLength: 1
   capacity:
     type: number
-  created_at:
-    type: string
-    format: date
-  favorites:
-    type: number
-  heat:
-    type: number
-  id:
-    $ref: ./WorldID.yaml
   imageUrl:
     type: string
-  labsPublicationDate:
+    minLength: 1
+  thumbnailImageUrl:
     type: string
-    # This is a date string unless there is no date, then it's 'none'
-    # oneOf: date, string did not generate
-    # format: date
-  name:
+    minLength: 1
+  releaseStatus:
     type: string
-  occupants:
-    type: number
+    minLength: 1
   organization:
     type: string
-  popularity:
-    type: number
-  publicationDate:
-    type: string
-    # This is a date string unless there is no date, then it's 'none'
-    # oneOf: date, string did not generate
-    # format: date
-  releaseStatus:
-    $ref: ./ReleaseStatus.yaml
+    minLength: 1
   tags:
     type: array
     items:
-      $ref: ./Tag.yaml
-  thumbnailImageUrl:
+      type: object
+  favorites:
+    type: number
+  created_at:
+    type: string
+    minLength: 1
+  updated_at:
+    type: string
+    minLength: 1
+  publicationDate:
+    type: string
+    minLength: 1
+  labsPublicationDate:
     type: string
-  # TODO
+    minLength: 1
   unityPackages:
     type: array
+    uniqueItems: true
+    minItems: 1
     items:
-      type: object
-  updated_at:
-    type: string
-    format: date
+      $ref: ./LimitedUnityPackage.yaml
+  popularity:
+    type: number
+  heat:
+    type: number
+  occupants:
+    type: number
 required:
+  - id
+  - name
   - authorId
   - authorName
   - capacity
-  - createdAt
-  - favorites
-  - heat
-  - id
   - imageUrl
-  - name
-  - organization
-  - popularity
-  - publicationDate
+  - thumbnailImageUrl
   - releaseStatus
+  - organization
   - tags
-  - thumbnailImageUrl
+  - favorites
+  - created_at
+  - updated_at
+  - publicationDate
+  - labsPublicationDate
   - unityPackages
-  - updatedAt
+  - popularity
+  - heat
+  - occupants

openapi/components/schemas/MIMEType.yaml

@@ -1,17 +1,18 @@
 type: string
 title: MIMEType
 enum:
-  - 'image⁄jpeg'
-  - 'image⁄jpg'
-  - 'image⁄png'
-  - 'image⁄webp'
-  - 'image⁄gif'
-  - 'image⁄bmp'
-  - 'image⁄svg＋xml'
-  - 'image⁄tiff'
-  - 'application⁄x-avatar'
-  - 'application⁄x-world'
-  - 'application⁄gzip'
-  - 'application/x-rsync-signature'
-  - 'application/x-rsync-delta'
-  - 'application/octet-stream'
+  - image/jpeg
+  - image/jpg
+  - image/png
+  - image/webp
+  - image/gif
+  - image/bmp
+  - image/svg＋xml
+  - image/tiff
+  - application/x-avatar
+  - application/x-world
+  - application/gzip
+  - application/x-rsync-signature
+  - application/x-rsync-delta
+  - application/octet-stream
+example: image/jpeg

openapi/components/schemas/Platform.yaml

@@ -0,0 +1,5 @@
+type: string
+title: Platform
+enum:
+  - standalonewindows
+  - android

openapi/components/schemas/UnityPackage.yaml

@@ -0,0 +1,53 @@
+description: ''
+type: object
+x-examples:
+  example-1:
+    id: unp_52b12c39-4163-457d-a4a9-630e7aff1bff
+    assetUrl: 'https://api.vrchat.cloud/api/1/file/file_cd0caa7b-69ba-4715-8dfe-7d667a9d2537/65/file'
+    assetUrlObject: {}
+    pluginUrl: ''
+    pluginUrlObject: {}
+    unityVersion: 2018.4.14f1
+    unitySortNumber: 20180414000
+    assetVersion: 4
+    platform: standalonewindows
+    created_at: '2020-09-10T06:13:27.777Z'
+title: UnityPackage
+properties:
+  id:
+    $ref: ./UnityPackageID.yaml
+  assetUrl:
+    type: string
+    minLength: 1
+  assetUrlObject:
+    type: object
+  pluginUrl:
+    type: string
+  pluginUrlObject:
+    type: object
+  unityVersion:
+    type: string
+    minLength: 1
+    example: 2018.4.12f1
+  unitySortNumber:
+    type: number
+    minimum: 0
+  assetVersion:
+    type: number
+  platform:
+    $ref: ./Platform.yaml
+  created_at:
+    type: string
+    minLength: 1
+    format: date-time
+required:
+  - id
+  - assetUrl
+  - assetUrlObject
+  - pluginUrl
+  - pluginUrlObject
+  - unityVersion
+  - unitySortNumber
+  - assetVersion
+  - platform
+  - created_at

openapi/components/schemas/UnityPackageID.yaml

@@ -0,0 +1,4 @@
+title: UnityPackageID
+type: string
+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}'
+example: unp_52b12c39-4163-457d-a4a9-630e7aff1bff

openapi/components/schemas/User.yaml

@@ -37,7 +37,7 @@ properties:
     type: string
     format: date-time
   last_platform:
-    type: string
+    $ref: ./Platform.yaml
   allowAvatarCopying:
     type: boolean
   status: