Skip to content

Update spec with missing fields #471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jun 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion openapi/components/paths/friends.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ paths:
- friends
responses:
'200':
$ref: ../responses/users/LimitedUserListResponse.yaml
$ref: ../responses/friends/LimitedUserFriendListResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
operationId: getFriends
Expand Down
4 changes: 2 additions & 2 deletions openapi/components/paths/users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ paths:
- users
responses:
'200':
$ref: ../responses/users/LimitedUserListResponse.yaml
$ref: ../responses/users/LimitedUserSearchListResponse.yaml
'400':
$ref: ../responses/users/UsersInvalidSearchError.yaml
'401':
Expand Down Expand Up @@ -125,7 +125,7 @@ paths:
schema:
type: array
items:
$ref: ../schemas/LimitedUser.yaml
$ref: ../schemas/LimitedUserFriend.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
'403':
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
description: Returns a list of LimitedUserFriend objects.
content:
application/json:
schema:
type: array
items:
$ref: ../../schemas/LimitedUserFriend.yaml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
description: Returns a list of LimitedUserSearch objects.
content:
application/json:
schema:
type: array
items:
$ref: ../../schemas/LimitedUserSearch.yaml
16 changes: 16 additions & 0 deletions openapi/components/schemas/Avatar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,21 @@ properties:
name:
minLength: 1
type: string
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
productId:
type: string
publishedListings:
Expand Down Expand Up @@ -116,6 +131,7 @@ required:
- id
- imageUrl
- name
- performance
- releaseStatus
- styles
- tags
Expand Down
2 changes: 2 additions & 0 deletions openapi/components/schemas/CurrentUserPresence.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ properties:
type: string
displayName:
type: string
debugflag:
type: string
groups:
type: array
nullable: true
Expand Down
2 changes: 1 addition & 1 deletion openapi/components/schemas/Instance.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ properties:
description: 'The users field is present on instances created by the requesting user.'
type: array
items:
$ref: ./LimitedUser.yaml
$ref: ./LimitedUserInstance.yaml
groupAccessType:
$ref: ./GroupAccessType.yaml
hasCapacityForYou:
Expand Down
3 changes: 3 additions & 0 deletions openapi/components/schemas/InstanceContentSettings.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,6 @@ properties:
stickers:
default: true
type: boolean
props:
default: true
type: boolean
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: ''
description: 'User object received when querying your friends list'
properties:
bio:
type: string
Expand All @@ -19,22 +19,35 @@ properties:
$ref: ./DeveloperType.yaml
displayName:
type: string
fallbackAvatar:
deprecated: true
$ref: ./AvatarID.yaml
friendKey:
type: string
id:
$ref: ./UserID.yaml
isFriend:
type: boolean
imageUrl:
type: string
last_platform:
$ref: ./Platform.yaml
location:
type: string
last_login:
type: string
nullable: true
format: date-time
last_activity:
type: string
nullable: true
format: date-time
last_mobile:
type: string
nullable: true
format: date-time
platform:
type: string
profilePicOverride:
type: string
pronouns:
profilePicOverrideThumbnail:
type: string
status:
$ref: ./UserStatus.yaml
Expand All @@ -47,23 +60,25 @@ properties:
type: array
userIcon:
type: string
username:
type: string
deprecated: true
description: -|
**DEPRECATED:** VRChat API no longer return usernames of other users. [See issue by Tupper for more information](https://github.com/pypy-vrc/VRCX/issues/429).
location:
type: string
friendKey:
type: string
required:
- id
- displayName
- statusDescription
- currentAvatarImageUrl
- developerType
- displayName
- friendKey
- id
- isFriend
- imageUrl
- last_platform
- location
- last_login
- last_activity
- last_mobile
- platform
- profilePicOverride
- profilePicOverrideThumbnail
- status
- isFriend
- statusDescription
- tags
title: LimitedUser
- userIcon
title: LimitedUserFriend
type: object
95 changes: 95 additions & 0 deletions openapi/components/schemas/LimitedUserInstance.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
description: 'User object received when querying your own instance'
properties:
ageVerificationStatus:
$ref: ./AgeVerificationStatus.yaml
ageVerified:
$ref: ./AgeVerified.yaml
allowAvatarCopying:
type: boolean
bio:
type: string
bioLinks:
description: ' '
type: array
items:
type: string
currentAvatarImageUrl:
$ref: ./CurrentAvatarImageUrl.yaml
currentAvatarThumbnailImageUrl:
$ref: ./CurrentAvatarThumbnailImageUrl.yaml
currentAvatarTags:
type: array
items:
$ref: ./Tag.yaml
date_joined:
type: string
nullable: true
format: date-time
developerType:
$ref: ./DeveloperType.yaml
displayName:
type: string
friendKey:
type: string
id:
$ref: ./UserID.yaml
isFriend:
type: boolean
imageUrl:
type: string
last_platform:
$ref: ./Platform.yaml
last_activity:
type: string
nullable: true
format: date-time
last_mobile:
type: string
nullable: true
format: date-time
platform:
type: string
profilePicOverride:
type: string
profilePicOverrideThumbnail:
type: string
pronouns:
type: string
state:
$ref: ./UserState.yaml
status:
$ref: ./UserStatus.yaml
statusDescription:
type: string
tags:
items:
$ref: ./Tag.yaml
type: array
userIcon:
type: string
required:
- ageVerificationStatus
- ageVerified
- allowAvatarCopying
- currentAvatarImageUrl
- currentAvatarThumbnailImageUrl
- currentAvatarTags
- date_joined
- developerType
- displayName
- friendKey
- id
- isFriend
- last_platform
- last_activity
- last_mobile
- profilePicOverride
- profilePicOverrideThumbnail
- pronouns
- state
- status
- statusDescription
- tags
- userIcon
title: LimitedUserInstance
type: object
58 changes: 58 additions & 0 deletions openapi/components/schemas/LimitedUserSearch.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
description: 'User object received when searching'
properties:
bio:
type: string
bioLinks:
description: ' '
type: array
items:
type: string
currentAvatarImageUrl:
$ref: ./CurrentAvatarImageUrl.yaml
currentAvatarThumbnailImageUrl:
$ref: ./CurrentAvatarThumbnailImageUrl.yaml
currentAvatarTags:
type: array
items:
$ref: ./Tag.yaml
developerType:
$ref: ./DeveloperType.yaml
displayName:
type: string
id:
$ref: ./UserID.yaml
isFriend:
type: boolean
last_platform:
$ref: ./Platform.yaml
profilePicOverride:
type: string
pronouns:
type: string
status:
$ref: ./UserStatus.yaml
statusDescription:
type: string
tags:
description: <- Always empty.
items:
$ref: ./Tag.yaml
type: array
userIcon:
type: string
required:
- currentAvatarImageUrl
- currentAvatarThumbnailImageUrl
- currentAvatarTags
- developerType
- displayName
- id
- isFriend
- last_platform
- profilePicOverride
- status
- statusDescription
- tags
- userIcon
title: LimitedUserSearch
type: object
3 changes: 3 additions & 0 deletions openapi/components/schemas/Subscription.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ properties:
picoSku:
type: string
minLength: 1
appleProductId:
type: string
minLength: 1
amount:
type: number
description:
Expand Down
2 changes: 2 additions & 0 deletions openapi/components/schemas/TokenBundle.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ properties:
type: string
oculusSku:
type: string
googleProductId:
type: string
amount:
type: integer
description: price of the bundle
Expand Down