Add public and private profile endpoints

openapi/components/paths.yaml

@@ -328,6 +328,10 @@
   $ref: "./paths/economy.yaml#/paths/~1products"
 "/products/{productId}":
   $ref: "./paths/economy.yaml#/paths/~1products~1{productId}"
+"/profile/{userId}":
+  $ref: "./paths/users.yaml#/paths/~1profile~1{userId}"
+"/profile/{userId}/private":
+  $ref: "./paths/users.yaml#/paths/~1profile~1{userId}~1private"
 /props:
   $ref: "./paths/props.yaml#/paths/~1props"
 "/props/{propId}":

openapi/components/paths/users.yaml

@@ -4,9 +4,41 @@
   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
+      security:
+        - authCookie: []
+      responses:
+        "200":
+          $ref: ../responses/users/PublicProfileResponse.yaml
+        "401":
+          $ref: ../responses/MissingCredentialsError.yaml
+  "/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
       summary: Get User Notes
       description: Get recently updated user notes
       tags:
@@ -52,13 +84,13 @@
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/users/UserNoteResponse.yaml
         "401":
           $ref: ../responses/MissingCredentialsError.yaml
   /users:
     get:
       operationId: searchUsers
       summary: Search All Users
       description: Search and list any users by text query
       tags:
@@ -89,7 +121,7 @@
           $ref: ../responses/MissingCredentialsError.yaml
   /users/active:
     get:
       operationId: searchActiveUsers
       x-internal: true
       deprecated: true
       summary: Search Active Users
@@ -137,8 +169,8 @@
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/users/UserResponse.yaml
         "401":
           $ref: ../responses/MissingCredentialsError.yaml
     put:
@@ -150,13 +182,13 @@
       requestBody:
         content:
           application/json:
             schema:
               $ref: ../requests/UpdateUserRequest.yaml
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/users/CurrentUserResponse.yaml
         "400":
           $ref: ../responses/users/CurrentPasswordRequiredError.yaml
         "401":
@@ -179,8 +211,8 @@
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/users/CurrentUserResponse.yaml
         "400":
           $ref: ../responses/users/UserTagInvalidError.yaml
         "401":
@@ -219,7 +251,7 @@
       - $ref: ../parameters.yaml#/number
       - $ref: ../parameters.yaml#/offset
     get:
       operationId: getUserFeedback
       deprecated: true
       summary: Get User Feedback
       description: Get user's submitted feedback
@@ -236,7 +268,7 @@
     parameters:
       - $ref: ../parameters.yaml#/userId
     get:
       operationId: getUserGroups
       summary: Get User Groups
       description: Get user's public groups
       tags:
@@ -252,7 +284,7 @@
     parameters:
       - $ref: ../parameters.yaml#/userId
     get:
       operationId: getInvitedGroups
       summary: Get User Group Invited
       description: Returns a list of Groups the user has been invited to.
       tags:
@@ -260,8 +292,8 @@
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/groups/GroupListResponse.yaml
         "401":
           $ref: ../responses/MissingCredentialsError.yaml
   "/users/{userId}/groups/permissions":
@@ -312,7 +344,7 @@
     parameters:
       - $ref: ../parameters.yaml#/userId
     get:
       operationId: getUserGroupRequests
       summary: Get User Group Requests
       description: Returns a list of Groups the user has requested to be invited into.
       tags:
@@ -320,15 +352,15 @@
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/groups/GroupListResponse.yaml
         "401":
           $ref: ../responses/MissingCredentialsError.yaml
   "/users/{userId}/groups/userblocked":
     parameters:
       - $ref: ../parameters.yaml#/userId
     get:
       operationId: getBlockedGroups
       summary: Get User Group Blocks
       description: Returns a list of Groups the user has blocked.
       tags:
@@ -336,8 +368,8 @@
       security:
         - authCookie: []
       responses:
         "200":
           $ref: ../responses/groups/GroupListResponse.yaml
         "401":
           $ref: ../responses/MissingCredentialsError.yaml
   "/users/{userId}/instances/groups":
@@ -399,7 +431,7 @@
       - $ref: ../parameters.yaml#/number
       - $ref: ../parameters.yaml#/offset
     get:
       operationId: getMutualFriends
       summary: Get User Mutual Friends
       description: Gets a list of mutual friends between the logged in user and the specified user
       tags:
@@ -417,7 +449,7 @@
       - $ref: ../parameters.yaml#/number
       - $ref: ../parameters.yaml#/offset
     get:
       operationId: getMutualGroups
       summary: Get User Mutual Groups
       description: Gets a list of mutual groups between the logged in user and the specified user
       tags:

openapi/components/responses/users/PrivateProfileResponse.yaml

@@ -0,0 +1,5 @@
+description: Returns profile data visible to the authenticated user.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/PrivateProfile.yaml

openapi/components/responses/users/PublicProfileResponse.yaml

@@ -0,0 +1,5 @@
+description: Returns a user's public profile.
+content:
+  application/json:
+    schema:
+      $ref: ../../schemas/PublicProfile.yaml

openapi/components/schemas/Badge.yaml

@@ -19,6 +19,8 @@ properties:
     type: boolean
     description: only present in CurrentUser badges
     nullable: true
+  isQuantifiable:
+    type: boolean
   showcased:
     type: boolean
   updatedAt:

openapi/components/schemas/LimitedUserSearch.yaml

@@ -2,6 +2,12 @@ title: LimitedUserSearch
 type: object
 description: User object received when searching
 properties:
+  bannerColor:
+    type: string
+  bannerType:
+    type: string
+  bannerUrl:
+    type: string
   bio:
     type: string
   bioLinks:
@@ -21,12 +27,20 @@ properties:
     $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
+  profileEffect:
+    type: string
   profilePicOverride:
     type: string
   pronouns:

openapi/components/schemas/PrivateProfile.yaml

@@ -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

openapi/components/schemas/PrivateProfileActivity.yaml

@@ -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

openapi/components/schemas/ProfileRepresentedGroup.yaml

@@ -0,0 +1,18 @@
+title: ProfileRepresentedGroup
+type: object
+properties:
+  bannerUrl:
+    type: string
+    nullable: true
+  iconUrl:
+    type: string
+    nullable: true
+  id:
+    $ref: ./GroupID.yaml
+  name:
+    type: string
+required:
+  - bannerUrl
+  - iconUrl
+  - id
+  - name

openapi/components/schemas/PublicProfile.yaml

@@ -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:
+    nullable: true
+    allOf:
+      - $ref: ./ProfileRepresentedGroup.yaml
+  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

openapi/components/schemas/User.yaml

@@ -13,6 +13,10 @@ properties:
     description: " "
     items:
       $ref: ./Badge.yaml
+  bannerType:
+    type: string
+  bannerUrl:
+    type: string
   bio:
     type: string
     maxLength: 512
@@ -41,10 +45,16 @@ properties:
     type: string
   friendRequestStatus:
     type: string
+  iconFrame:
+    type: string
+  iconUrl:
+    type: string
   id:
     $ref: ./UserID.yaml
   instanceId:
     $ref: ./InstanceID.yaml
+  isEconomyCreator:
+    type: boolean
   isFriend:
     type: boolean
     description: "Either their `friendKey`, or empty string if you are not friends. Unknown usage."
@@ -61,10 +71,14 @@ properties:
     $ref: ./Platform.yaml
   location:
     $ref: ./LocationID.yaml
+  nameplateEffect:
+    type: string
   note:
     type: string
   platform:
     type: string
+  profileEffect:
+    type: string
   profilePicOverride:
     type: string
   profilePicOverrideThumbnail: