Skip to content

Commit

Permalink
Merge branch 'main' into fix/swap-rest-to-new-domain
Browse files Browse the repository at this point in the history
  • Loading branch information
jellejurre committed Nov 20, 2024
2 parents 3f3604e + 30ad99c commit 80b8580
Show file tree
Hide file tree
Showing 45 changed files with 1,048 additions and 12 deletions.
36 changes: 36 additions & 0 deletions openapi/components/codeSamples/economy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,39 @@
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/licenseGroups/{licenseGroupId}" \
-b "auth={authCookie}"
'/listing/{productId}':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/listing/{productId}" \
-b "auth={authCookie}"
'/user/{userId}/listings':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/user/{userId}/listings?hydrate=true" \
-b "auth={authCookie}"
'/tokenBundles':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/tokenBundles" \
-b "auth={authCookie}"
'/tilia/status':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/tilia/status" \
-b "auth={authCookie}"
'/user/{userId}/tilia/tos':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/user/{userId}/tilia/tos" \
-b "auth={authCookie}"
'/user/{userId}/balance':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/user/{userId}/balance" \
-b "auth={authCookie}"
6 changes: 6 additions & 0 deletions openapi/components/codeSamples/favorites.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@
source: >-
curl -X DELETE "https://api.vrchat.cloud/api/1/favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId}" \
-b "auth={authCookie}"
'/auth/user/favoritelimits':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/auth/user/favoritelimits" \
-b "auth={authCookie}"
20 changes: 19 additions & 1 deletion openapi/components/codeSamples/files.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,27 @@
source: >-
curl -X PUT "https://api.vrchat.cloud/api/1/file/{fileId}/{versionId}/{fileType}/start" \
-b "auth={authCookie}"
/file/{fieldId}/{versionId}/{fileType}/status:
/file/{fileId}/{versionId}/{fileType}/status:
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/file/{fileId}/{versionId}/{fileType}/status" \
-b "auth={authCookie}"
/analysis/{fileId}/{versionId}:
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/file/{fileId}/{versionId}" \
-b "auth={authCookie}"
/analysis/{fileId}/{versionId}/security:
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/file/{fileId}/{versionId}/security" \
-b "auth={authCookie}"
/analysis/{fileId}/{versionId}/standard:
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/file/{fileId}/{versionId}/standard" \
-b "auth={authCookie}"
27 changes: 26 additions & 1 deletion openapi/components/codeSamples/users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,32 @@
put:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/users/{userId}" \
curl -X PUT "https://api.vrchat.cloud/api/1/users/{userId}" \
-H "Content-Type: application/json" \
-b "auth={authCookie}" \
--data '{"email": "string", "birthday": "2019-08-24", "acceptedTOSVersion": 0, "tags": ["string"], "status": "active", "statusDescription": "string", "bio": "string", "bioLinks": ["string"], "userIcon": "https://api.vrchat.cloud/api/1/file/file_76dc2964-0ce8-41df-b2e7-8edf994fee31/1"}'
'/users/{userId}/feedback':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/users/{userId}/feedback?n=100" \
-b "auth={authCookie}"
'/userNotes':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/userNotes?n=100" \
-b "auth={authCookie}"
post:
- lang: cURL
source: >-
curl -X POST "https://api.vrchat.cloud/api/1/userNotes" \
-H "Content-Type: application/json" \
-b "auth={authCookie}" \
--data '{"targetUserId": "userId", "note": "string"}'
'/userNotes/{userNoteId}':
get:
- lang: cURL
source: >-
curl -X GET "https://api.vrchat.cloud/api/1/userNotes/{userNoteId}" \
-b "auth={authCookie}"
43 changes: 43 additions & 0 deletions openapi/components/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ sort:
schema:
$ref: ./schemas/SortOption.yaml
description: The sort order of the results.
hydrate:
name: hydrate
in: query
required: false
schema:
type: boolean
description: Populates some fields and changes types of others for certain objects.
groupMemberSort:
name: sort
in: query
Expand Down Expand Up @@ -90,6 +97,14 @@ groupId:
type: string
example: grp_00000000-0000-0000-0000-000000000000
description: Must be a valid group ID.
groupIdFilter:
name: groupId
in: query
required: false
schema:
type: string
example: grp_00000000-0000-0000-0000-000000000000
description: Must be a valid group ID.
groupRoleId:
name: groupRoleId
in: path
Expand Down Expand Up @@ -149,6 +164,13 @@ userIdQuery:
schema:
type: string
description: Filter by UserID.
userNoteId:
name: userNoteId
in: path
required: true
schema:
type: string
description: Must be a valid user note ID.
usernameQuery:
name: username
in: query
Expand Down Expand Up @@ -337,6 +359,27 @@ licenseGroupId:
schema:
type: string
description: Must be a valid license group ID.
productId:
name: productId
in: path
required: true
schema:
type: string
description: Must be a valid product ID.
contentId:
name: contentId
in: query
required: false
schema:
type: boolean
description: Filter for users' previously submitted feedback, e.g., a groupId, useeId, avatarId, etc.
active:
name: active
in: query
required: false
schema:
type: boolean
description: Filter for users' listings.
variant:
name: variant
in: query
Expand Down
26 changes: 26 additions & 0 deletions openapi/components/paths.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@
$ref: "./paths/economy.yaml#/paths/~1subscriptions"
'/licenseGroups/{licenseGroupId}':
$ref: "./paths/economy.yaml#/paths/~1licenseGroups~1{licenseGroupId}"
'/listing/{productId}':
$ref: "./paths/economy.yaml#/paths/~1listing~1{productId}"
'/user/{userId}/listings':
$ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1listings"
'/tokenBundles':
$ref: "./paths/economy.yaml#/paths/~1tokenBundles"
'/tilia/status':
$ref: "./paths/economy.yaml#/paths/~1tilia~1status"
'/user/{userId}/tilia/tos':
$ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1tilia~1tos"
'/user/{userId}/balance':
$ref: "./paths/economy.yaml#/paths/~1user~1{userId}~1balance"

# favorites

Expand All @@ -63,6 +75,8 @@
$ref: "./paths/favorites.yaml#/paths/~1favorite~1groups"
"/favorite/group/{favoriteGroupType}/{favoriteGroupName}/{userId}":
$ref: "./paths/favorites.yaml#/paths/~1favorite~1group~1{favoriteGroupType}~1{favoriteGroupName}~1{userId}"
"/auth/user/favoritelimits":
$ref: "./paths/favorites.yaml#/paths/~1auth~1user~1favoritelimits"

# files

Expand All @@ -80,6 +94,12 @@
$ref: "./paths/files.yaml#/paths/~1file~1{fileId}~1{versionId}~1{fileType}~1start"
"/file/{fileId}/{versionId}/{fileType}/status":
$ref: "./paths/files.yaml#/paths/~1file~1{fileId}~1{versionId}~1{fileType}~1status"
"/analysis/{fileId}/{versionId}":
$ref: "./paths/files.yaml#/paths/~1analysis~1{fileId}~1{versionId}"
"/analysis/{fileId}/{versionId}/security":
$ref: "./paths/files.yaml#/paths/~1analysis~1{fileId}~1{versionId}~1security"
"/analysis/{fileId}/{versionId}/standard":
$ref: "./paths/files.yaml#/paths/~1analysis~1{fileId}~1{versionId}~1standard"

# friends

Expand Down Expand Up @@ -244,6 +264,12 @@
$ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1requested"
"/users/{userId}/groups/represented":
$ref: "./paths/users.yaml#/paths/~1users~1{userId}~1groups~1represented"
"/users/{userId}/feedback":
$ref: "./paths/users.yaml#/paths/~1users~1{userId}~1feedback"
"/userNotes":
$ref: "./paths/users.yaml#/paths/~1userNotes"
"/userNotes/{userNoteId}":
$ref: "./paths/users.yaml#/paths/~1userNotes~1{userNoteId}"

# worlds

Expand Down
110 changes: 110 additions & 0 deletions openapi/components/paths/economy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,116 @@ paths:
tags:
- economy
description: Get a single License Group by given ID.
'/listing/{productId}':
parameters:
- $ref: ../parameters.yaml#/productId
- $ref: ../parameters.yaml#/hydrate
get:
summary: Get Product Listing
operationId: getProductListing
security:
- authCookie: []
x-codeSamples:
$ref: "../codeSamples/economy.yaml#/~1listing~1{productId}/get"
responses:
'200':
$ref: ../responses/economy/ProductListingResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
tags:
- economy
description: 'Gets a product listing'
'/user/{userId}/listings':
parameters:
- $ref: ../parameters.yaml#/userId
- $ref: ../parameters.yaml#/number
- $ref: ../parameters.yaml#/offset
- $ref: ../parameters.yaml#/hydrate
- $ref: ../parameters.yaml#/groupIdFilter
- $ref: ../parameters.yaml#/active
get:
summary: Get User Product Listings
operationId: getProductListings
security:
- authCookie: []
x-codeSamples:
$ref: "../codeSamples/economy.yaml#/~1user~1{userId}~1listings/get"
responses:
'200':
$ref: ../responses/economy/ProductListingListResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
tags:
- economy
description: Gets the product listings of a given user
'/tokenBundles':
get:
summary: List Token Bundles
operationId: getTokenBundles
security:
- authCookie: []
x-codeSamples:
$ref: "../codeSamples/economy.yaml#/~1tokenBundles/get"
responses:
'200':
$ref: ../responses/economy/TokenBundleListResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
tags:
- economy
description: 'Gets the list of token bundles'
'/tilia/status':
get:
summary: Get Tilia Status
operationId: getTiliaStatus
security:
- authCookie: []
x-codeSamples:
$ref: "../codeSamples/economy.yaml#/~1tilia~1status/get"
responses:
'200':
$ref: ../responses/economy/TiliaStatusResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
tags:
- economy
description: 'Gets the status of Tilia integration'
'/user/{userId}/tilia/tos':
parameters:
- $ref: ../parameters.yaml#/userId
get:
summary: Get Tilia TOS Agreement Status
operationId: getTiliaTos
security:
- authCookie: []
x-codeSamples:
$ref: "../codeSamples/economy.yaml#/~1user~1{userId}~1tilia~1tos/get"
responses:
'200':
$ref: ../responses/economy/TiliaTOSResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
tags:
- economy
description: 'Gets the status of the agreement of a user to the Tilia TOS'
'/user/{userId}/balance':
parameters:
- $ref: ../parameters.yaml#/userId
get:
summary: Get Balance
operationId: getBalance
security:
- authCookie: []
x-codeSamples:
$ref: "../codeSamples/economy.yaml#/~1user~1{userId}~1balance/get"
responses:
'200':
$ref: ../responses/economy/BalanceResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
tags:
- economy
description: 'Gets the balance of a user'
tags:
$ref: ../tags.yaml
components:
Expand Down
18 changes: 18 additions & 0 deletions openapi/components/paths/favorites.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,24 @@ paths:
tags:
- favorites
description: Clear ALL contents of a specific favorite group.
'/auth/user/favoritelimits':
parameters: []
get:
summary: Get Favorite Limits
tags:
- favorites
x-codeSamples:
$ref: "../codeSamples/favorites.yaml#/~1auth~1user~1favoritelimits/get"
responses:
'200':
$ref: ../responses/favorites/FavoriteLimitsResponse.yaml
'401':
$ref: ../responses/MissingCredentialsError.yaml
operationId: getFavoriteLimits
security:
- authCookie: []
description: Return information about a specific Favorite.
parameters: []
tags:
$ref: ../tags.yaml
components:
Expand Down
Loading

0 comments on commit 80b8580

Please sign in to comment.