Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
87e2c20
POC Websocket types
C0D3-M4513R Sep 16, 2026
051f92a
POC v2 Websocket types
C0D3-M4513R Sep 16, 2026
de8d757
Notification types
C0D3-M4513R Sep 16, 2026
ad02a7b
Friend types
C0D3-M4513R Sep 16, 2026
6c14578
Rest of the types
C0D3-M4513R Sep 16, 2026
8e7a036
ContentRefresh changes
C0D3-M4513R Sep 16, 2026
04d2e85
The NotificationDetails are used in the WebsocketNotification now
C0D3-M4513R Sep 16, 2026
015c8f7
Update Notification.yaml to clarify the double-json encoding properly…
C0D3-M4513R Sep 16, 2026
44fabdf
Constrain WebsocketClearNotification
C0D3-M4513R Sep 16, 2026
d80beb2
Fix wrong property name
C0D3-M4513R Sep 16, 2026
fd6f27a
Misspelling of required as requires
C0D3-M4513R Sep 16, 2026
91a8436
Fix wrong key in required
C0D3-M4513R Sep 16, 2026
f820e13
See, Hide and Clear Notifications are not double json encoded
C0D3-M4513R Sep 16, 2026
0359da5
Clear Notifications got a wrong type reference
C0D3-M4513R Sep 16, 2026
2ea6233
Wrong name
C0D3-M4513R Sep 16, 2026
09252f3
Lint
C0D3-M4513R Sep 16, 2026
ae95623
Lint2
C0D3-M4513R Sep 16, 2026
d446294
Lint3
C0D3-M4513R Sep 16, 2026
178da84
Lint Warnings
C0D3-M4513R Sep 16, 2026
efc2dff
Please generate proper code for double-json deserialization?
C0D3-M4513R Sep 16, 2026
5dc7743
Fix x-if?
C0D3-M4513R Sep 16, 2026
f1f22bf
Lint1
C0D3-M4513R Sep 16, 2026
2c31cb6
Lint2
C0D3-M4513R Sep 16, 2026
d4cd095
Lint3
C0D3-M4513R Sep 16, 2026
4317935
Remove probably? unused propertyBaseName
C0D3-M4513R Sep 16, 2026
31dae62
Change how Websocket Message enums are decoded
C0D3-M4513R Sep 16, 2026
e74012f
Fix "InlineObject<n>" Names
C0D3-M4513R Sep 16, 2026
c7fee03
Regex-Replace usages of `nullable: true`
C0D3-M4513R Sep 16, 2026
ee803b3
Fix Encoded Types
C0D3-M4513R Sep 16, 2026
5b5f3d6
Lint
C0D3-M4513R Sep 17, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions openapi/components/requests/CreateGroupGalleryRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,23 @@ properties:
example: Example Gallery
minLength: 1
roleIdsToAutoApprove:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
roleIdsToManage:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
roleIdsToSubmit:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
roleIdsToView:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
required:
Expand Down
6 changes: 2 additions & 4 deletions openapi/components/requests/CreateGroupRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@ title: CreateGroupRequest
type: object
properties:
bannerId:
type: string
nullable: true
type: ["null", string]
default: null
description:
type: string
maxLength: 250
minLength: 0
iconId:
type: string
nullable: true
type: ["null", string]
default: null
joinState:
$ref: ../schemas/GroupJoinState.yaml
Expand Down
6 changes: 2 additions & 4 deletions openapi/components/requests/CreateInstanceRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,14 @@ properties:
description: Currently unused, but will eventually be a flag to set if the closing of the instance should kick people.
default: false
instancePersistenceEnabled:
type: boolean
nullable: true
type: [boolean, "null"]
inviteOnly:
type: boolean
default: false
ownerId:
$ref: ../schemas/InstanceOwnerId.yaml
playerPersistenceEnabled:
type: boolean
nullable: true
type: [boolean, "null"]
queueEnabled:
type: boolean
default: false
Expand Down
12 changes: 4 additions & 8 deletions openapi/components/requests/UpdateGroupGalleryRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,26 +17,22 @@ properties:
example: Example Gallery
minLength: 1
roleIdsToAutoApprove:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
roleIdsToManage:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
roleIdsToSubmit:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
roleIdsToView:
type: array
type: [array, "null"]
description: " "
nullable: true
items:
$ref: ../schemas/GroupRoleID.yaml
6 changes: 2 additions & 4 deletions openapi/components/requests/UpdateGroupRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,14 @@ title: UpdateGroupRequest
type: object
properties:
bannerId:
type: string
nullable: true
type: ["null", string]
default: null
description:
type: string
maxLength: 250
minLength: 0
iconId:
type: string
nullable: true
type: ["null", string]
default: null
joinState:
$ref: ../schemas/GroupJoinState.yaml
Expand Down
3 changes: 1 addition & 2 deletions openapi/components/requests/UpdateWorldRequest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,7 @@ properties:
platform:
$ref: ../schemas/Platform.yaml
previewYoutubeId:
type: string
nullable: true
type: ["null", string]
recommendedCapacity:
type: integer
example: 4
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ content:
x-if:
when: jsonschema
then:
title: LoginOr2fa
oneOf:
- $ref: ../../schemas/CurrentUser.yaml
- $ref: ../../schemas/RequiresTwoFactorAuth.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@ description: Returns a UserSubscription object.
content:
application/json:
schema:
type: object
nullable: true
type: ["null", object]
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ description: Returns a list of GroupGalleryImage objects, wrapped in a paginated
content:
application/json:
schema:
title: GroupGalleryImageListResponse
oneOf:
- type: array
items:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ description: Returns a list of GroupMember objects from a search.
content:
application/json:
schema:
title: GroupMemberSearchResponse
type: object
properties:
results:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ description: Returns a GroupPost Array.
content:
application/json:
schema:
title: GroupPostsResponse
type: object
properties:
posts:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ description: Returns a list of Instance objects with a fetched at time.
content:
application/json:
schema:
title: UserGroupInstanceListResponse
type: object
properties:
fetchedAt:
Expand Down
1 change: 1 addition & 0 deletions openapi/components/responses/users/UserResponse.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ content:
x-if:
when: jsonschema
then:
title: UserResponse
oneOf:
- $ref: ../../schemas/User.yaml
- $ref: ../../schemas/CurrentUser.yaml
Expand Down
3 changes: 1 addition & 2 deletions openapi/components/schemas/AccountDeletionLog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,8 @@ properties:
description: Date and time of the deletion request.
format: date-time
deletionScheduled:
type: string
type: ["null", string]
description: When the deletion is scheduled to happen, standard is 14 days after the request.
nullable: true
format: date-time
message:
type: string
Expand Down
3 changes: 1 addition & 2 deletions openapi/components/schemas/AdminAssetBundle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ properties:
thumbnailImageUrl:
type: string
unityPackageUrl:
type: string
nullable: true
type: ["null", string]
unityPackages:
type: array
items:
Expand Down
9 changes: 3 additions & 6 deletions openapi/components/schemas/Avatar.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
title: Avatar
type: object
description: ""

Check warning on line 3 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
properties:
acknowledgements:
type: string
Expand All @@ -12,11 +12,11 @@
description: "Not present from general search `/avatars`, only on specific
requests `/avatars/{avatarId}`."
minLength: 1
assetUrlObject:
type: object
description: |-
Not present from general search `/avatars`, only on specific requests `/avatars/{avatarId}`.
**Deprecation:** `Object` has unknown usage/fields, and is always empty. Use normal `Url` field instead.

Check warning on line 19 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
attribution: {}
authorId:
$ref: ./UserID.yaml
Expand All @@ -40,8 +40,7 @@
type: string
minLength: 1
listingDate:
type: string
nullable: true
type: ["null", string]
lock:
type: boolean
lowestPrice:
Expand All @@ -52,61 +51,59 @@
pendingUpload:
type: boolean
default: false
performance:
type: object
properties:
android:
type: string
android-sort:
type: integer
ios:
type: string
ios-sort:
type: integer
standalonewindows:
type: string
standalonewindows-sort:
type: integer

Check warning on line 68 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
productId:
type: string
publishedListings:
type: array
items:
type: object
properties:
description:
type: string
displayName:
type: string
imageId:
type: string
listingId:
type: string
listingType:
type: string
priceTokens:
type: integer

Check warning on line 87 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
releaseStatus:
$ref: ./ReleaseStatus.yaml
searchable:
type: boolean
default: false
styles:
type: object
properties:
primary:
type: string
nullable: true
type: ["null", string]
secondary:
type: string
nullable: true
type: ["null", string]
supplementary:
type: array
items:
type: string

Check warning on line 103 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
tags:
type: array
description: " "

Check warning on line 106 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
items:
$ref: ./Tag.yaml
thumbnailImageUrl:
Expand All @@ -114,14 +111,14 @@
minLength: 1
unityPackageUrl:
type: string
unityPackageUrlObject:
deprecated: true
type: object
description: "**Deprecation:** `Object` has unknown usage/fields, and is always
empty. Use normal `Url` field instead."
properties:
unityPackageUrl:
type: string

Check warning on line 121 in openapi/components/schemas/Avatar.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
unityPackages:
type: array
items:
Expand Down
9 changes: 3 additions & 6 deletions openapi/components/schemas/Badge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@ title: Badge
type: object
properties:
assignedAt:
type: string
type: ["null", string]
description: only present in CurrentUser badges
nullable: true
format: date-time
badgeDescription:
type: string
Expand All @@ -16,17 +15,15 @@ properties:
badgeName:
type: string
hidden:
type: boolean
type: [boolean, "null"]
description: only present in CurrentUser badges
nullable: true
isQuantifiable:
type: boolean
showcased:
type: boolean
updatedAt:
type: string
type: ["null", string]
description: only present in CurrentUser badges
nullable: true
format: date-time
required:
- badgeDescription
Expand Down
15 changes: 5 additions & 10 deletions openapi/components/schemas/CalendarEvent.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
type: string
format: date-time
deletedAt:
type: string
nullable: true
type: ["null", string]
format: date-time
description:
type: string
Expand All @@ -35,8 +34,7 @@
$ref: ./FileID.yaml
nullable: true
imageUrl:
type: string
nullable: true
type: ["null", string]
interestedUserCount:
type: integer
isDraft:
Expand All @@ -49,8 +47,7 @@
occurrenceKind:
$ref: ./CalendarEventOccurrenceKind.yaml
occurrenceModified:
type: boolean
nullable: true
type: [boolean, "null"]
ownerId:
$ref: ./GroupID.yaml
platforms:
Expand All @@ -60,15 +57,13 @@
recurrence:
$ref: ./CalendarEventRecurrence.yaml
roleIds:
type: array
type: [array, "null"]
description: Group roles that may join this event
nullable: true
items:
$ref: ./GroupRoleID.yaml
seriesId:
type: string
type: ["null", string]
description: So far unused, always "null"
nullable: true
startsAt:
type: string
format: date-time
Expand All @@ -86,17 +81,17 @@
updatedAt:
type: string
format: date-time
userInterest:
type: object
properties:
createdAt:
type: string
format: date-time
isFollowing:
type: boolean
updatedAt:
type: string
format: date-time

Check warning on line 94 in openapi/components/schemas/CalendarEvent.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.
usesInstanceOverflow:
type: boolean
required:
Expand Down
3 changes: 1 addition & 2 deletions openapi/components/schemas/CalendarEventRecurrence.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
title: CalendarEventRecurrence
type: object
type: ["null", object]
description: Details about how a recurring event will be scheduled. If the event is to be scheduled indefinitely, this will lack an "end" property.
nullable: true
properties:
daysOfWeek:
type: array
Expand Down
21 changes: 7 additions & 14 deletions openapi/components/schemas/CurrentUser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,16 @@
example: 7
minimum: 0
accountDeletionDate:
type: string
nullable: true
type: ["null", string]
format: date
accountDeletionLog:
type: array
type: [array, "null"]
description: " "

Check warning on line 17 in openapi/components/schemas/CurrentUser.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
nullable: true
items:
$ref: ./AccountDeletionLog.yaml
activeFriends:
type: array
description: " "

Check warning on line 22 in openapi/components/schemas/CurrentUser.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
items:
$ref: ./UserID.yaml
ageVerificationStatus:
Expand Down Expand Up @@ -141,8 +139,7 @@
type: string
format: date-time
last_mobile:
type: string
nullable: true
type: ["null", string]
format: date-time
last_platform:
$ref: ./Platform.yaml
Expand Down Expand Up @@ -201,8 +198,7 @@
items:
type: string
queuedInstance:
type: string
nullable: true
type: ["null", string]
receiveMobileInvitations:
type: boolean
state:
Expand Down Expand Up @@ -239,20 +235,17 @@
twoFactorAuthEnabled:
type: boolean
twoFactorAuthEnabledDate:
type: string
nullable: true
type: ["null", string]
format: date-time
unsubscribe:
type: boolean
updated_at:
type: string
format: date-time
userLanguage:
type: string
nullable: true
type: ["null", string]
userLanguageCode:
type: string
nullable: true
type: ["null", string]
username:
type: string
description: Your own unique name, used during login. Distinct from
Expand Down
Loading
Loading