Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
4 changes: 4 additions & 0 deletions openapi/components/paths.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -318,6 +318,10 @@
$ref: "./paths/miscellaneous.yaml#/paths/~1permissions"
"/permissions/{permissionId}":
$ref: "./paths/miscellaneous.yaml#/paths/~1permissions~1{permissionId}"
"/profile/{userId}":

Check failure on line 321 in openapi/components/paths.yaml

View workflow job for this annotation

GitHub Actions / lint

Expected mapping keys to be in specified order. '/profile/{userId}' should be after '/products/{productId}'.
$ref: "./paths/users.yaml#/paths/~1profile~1{userId}"
"/profile/{userId}/private":

Check failure on line 323 in openapi/components/paths.yaml

View workflow job for this annotation

GitHub Actions / lint

Expected mapping keys to be in specified order. '/profile/{userId}/private' should be after '/products/{productId}'.
$ref: "./paths/users.yaml#/paths/~1profile~1{userId}~1private"
/prints:
$ref: "./paths/prints.yaml#/paths/~1prints"
"/prints/user/{userId}":
Expand Down
28 changes: 28 additions & 0 deletions openapi/components/paths/users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,34 @@ info:
description: Users Docs Here
version: "1.0"
paths:
"/profile/{userId}":
parameters:
- $ref: ../parameters.yaml#/userId
get:
operationId: getPublicProfile
summary: Get Public Profile
description: Get a user's public profile information.
tags:
- users
responses:
"200":
$ref: ../responses/users/PublicProfileResponse.yaml
Comment thread
Miner28 marked this conversation as resolved.
"/profile/{userId}/private":
parameters:
- $ref: ../parameters.yaml#/userId
get:
operationId: getPrivateProfile
summary: Get Private Profile
description: Get profile information visible to the currently authenticated user.
tags:
- users
security:
- authCookie: []
responses:
"200":
$ref: ../responses/users/PrivateProfileResponse.yaml
"401":
$ref: ../responses/MissingCredentialsError.yaml
/userNotes:
get:
operationId: getUserNotes
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
description: Returns profile data visible to the authenticated user.
content:
application/json:
schema:
$ref: ../../schemas/PrivateProfile.yaml
5 changes: 5 additions & 0 deletions openapi/components/responses/users/PublicProfileResponse.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
description: Returns a user's public profile.
content:
application/json:
schema:
$ref: ../../schemas/PublicProfile.yaml
2 changes: 2 additions & 0 deletions openapi/components/schemas/Badge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ properties:
type: boolean
description: only present in CurrentUser badges
nullable: true
isQuantifiable:
type: boolean
showcased:
type: boolean
updatedAt:
Expand Down
14 changes: 14 additions & 0 deletions openapi/components/schemas/LimitedUserSearch.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
type: object
description: User object received when searching
properties:
bannerColor:
type: string
bannerType:
type: string
bannerUrl:
type: string
bio:
type: string
bioLinks:
Expand All @@ -21,14 +27,22 @@
$ref: ./DeveloperType.yaml
displayName:
type: string
iconFrame:
type: string
iconUrl:
type: string
id:
$ref: ./UserID.yaml
isFriend:
type: boolean
last_platform:
$ref: ./Platform.yaml
nameplateEffect:
type: string
profilePicOverride:

Check failure on line 42 in openapi/components/schemas/LimitedUserSearch.yaml

View workflow job for this annotation

GitHub Actions / lint

Expected mapping keys to be in specified order. 'profilePicOverride' should be after 'profileEffect'.
type: string
profileEffect:
type: string
pronouns:
type: string
status:
Expand Down
22 changes: 22 additions & 0 deletions openapi/components/schemas/PrivateProfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
title: PrivateProfile
type: object
properties:
activity:
$ref: ./PrivateProfileActivity.yaml
id:
$ref: ./UserID.yaml
isFriend:
type: boolean
note:
type: string
status:
$ref: ./UserStatus.yaml
statusDescription:
type: string
required:
- activity
- id
- isFriend
- note
- status
- statusDescription
36 changes: 36 additions & 0 deletions openapi/components/schemas/PrivateProfileActivity.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
title: PrivateProfileActivity
type: object
properties:
instanceId:
$ref: ./InstanceID.yaml
last_activity:
type: string
description: Either a date-time or an empty string.
last_login:
type: string
description: Either a date-time or an empty string.
location:
$ref: ./LocationID.yaml
platform:
$ref: ./Platform.yaml
state:
$ref: ./UserState.yaml
travelingToInstance:
type: string
travelingToLocation:
type: string
travelingToWorld:
type: string
worldId:
$ref: ./WorldID.yaml
required:
- instanceId
- last_activity
- last_login
- location
- platform
- state
- travelingToInstance
- travelingToLocation
- travelingToWorld
- worldId
16 changes: 16 additions & 0 deletions openapi/components/schemas/ProfileRepresentedGroup.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
title: ProfileRepresentedGroup
type: object
properties:
bannerUrl:
type: string
iconUrl:
type: string
Comment thread
Copilot marked this conversation as resolved.
id:
$ref: ./GroupID.yaml
name:
type: string
required:
- bannerUrl
- iconUrl
- id
- name
77 changes: 77 additions & 0 deletions openapi/components/schemas/PublicProfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
title: PublicProfile
type: object
properties:
ageVerificationStatus:
$ref: ./AgeVerificationStatus.yaml
ageVerified:
$ref: ./AgeVerified.yaml
backgroundType:
type: string
badges:
type: array
items:
$ref: ./Badge.yaml
bannerColor:
type: string
bannerType:
type: string
bio:
type: string
bioLinks:
type: array
items:
type: string
displayName:
type: string
hasVrcPlus:
type: boolean
iconFrame:
type: string
iconUrl:
type: string
id:
$ref: ./UserID.yaml
isEconomyCreator:
type: boolean
languages:
type: array
items:
type: string
nameplateEffect:
type: string
profileEffect:
type: string
pronouns:
type: string
representedGroup:
allOf:

Check failure on line 47 in openapi/components/schemas/PublicProfile.yaml

View workflow job for this annotation

GitHub Actions / lint

Expected mapping keys to be in specified order. 'allOf' should be after 'nullable'.
- $ref: ./ProfileRepresentedGroup.yaml
nullable: true
themeId:
type: string
trustTags:
type: array
items:
$ref: ./Tag.yaml
required:
- ageVerificationStatus
- ageVerified
- backgroundType
- badges
- bannerColor
- bannerType
- bio
- bioLinks
- displayName
- hasVrcPlus
- iconFrame
- iconUrl
- id
- isEconomyCreator
- languages
- nameplateEffect
- profileEffect
- pronouns
- representedGroup
- themeId
- trustTags
14 changes: 14 additions & 0 deletions openapi/components/schemas/User.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
description: " "
items:
$ref: ./Badge.yaml
bannerType:
type: string
bannerUrl:
type: string
bio:
type: string
maxLength: 512
Expand Down Expand Up @@ -41,13 +45,19 @@
type: string
friendRequestStatus:
type: string
iconFrame:
type: string
iconUrl:
type: string
id:
$ref: ./UserID.yaml
instanceId:
$ref: ./InstanceID.yaml
isFriend:

Check failure on line 56 in openapi/components/schemas/User.yaml

View workflow job for this annotation

GitHub Actions / lint

Expected mapping keys to be in specified order. 'isFriend' should be after 'isEconomyCreator'.
type: boolean
description: "Either their `friendKey`, or empty string if you are not friends. Unknown usage."
isEconomyCreator:
type: boolean
last_activity:
type: string
description: Either a date-time or empty string.
Expand All @@ -61,6 +71,8 @@
$ref: ./Platform.yaml
location:
$ref: ./LocationID.yaml
nameplateEffect:
type: string
note:
type: string
platform:
Expand All @@ -69,6 +81,8 @@
type: string
profilePicOverrideThumbnail:
type: string
profileEffect:

Check failure on line 84 in openapi/components/schemas/User.yaml

View workflow job for this annotation

GitHub Actions / lint

Expected mapping keys to be in specified order. 'profileEffect' should be before 'profilePicOverride'.
type: string
pronouns:
type: string
state:
Expand Down
Loading