Skip to content
Open
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
7 changes: 7 additions & 0 deletions openapi/components/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -301,12 +301,12 @@
in: query
schema:
$ref: ./schemas/UserID.yaml
fuzzy:
name: fuzzy
required: false
in: query
schema:
type: boolean

Check warning on line 309 in openapi/components/parameters.yaml

View workflow job for this annotation

GitHub Actions / lint

oas3-parameter-description

Parameter objects must have "description".
groupByDuration:
name: groupByDuration
description: Time bucket size for economy metrics. Observed values include `days` and `years`.
Expand Down Expand Up @@ -364,6 +364,13 @@
in: path
schema:
$ref: ./schemas/GroupRoleID.yaml
groupShortCodeAndDiscriminator:
name: groupShortCodeAndDiscriminator
description: Must be a valid group short code and discriminator.
required: true
in: path
schema:
$ref: ./schemas/GroupShortCodeAndDiscriminator.yaml
hydrate:
name: hydrate
description: Populates some fields and changes types of others for certain objects.
Expand Down Expand Up @@ -471,7 +478,7 @@
$ref: ./schemas/InventoryItemType.yaml
inventoryPedestalDuration:
name: duration
description: The duration before the sharing pedestal despawns.

Check notice on line 481 in openapi/components/parameters.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: despawns, did you mean despairs, deans, or dedans?
required: true
in: query
schema:
Expand Down Expand Up @@ -645,12 +652,12 @@
schema:
type: string
format: date-time
mostRecentFlag:
name: mostRecent
required: false
in: query
schema:
type: boolean

Check warning on line 660 in openapi/components/parameters.yaml

View workflow job for this annotation

GitHub Actions / lint

oas3-parameter-description

Parameter objects must have "description".
noplatform:
name: noplatform
description: The platform the asset does not support.
Expand Down Expand Up @@ -834,18 +841,18 @@
schema:
type: string
example: game night
storeId:
name: storeId
required: true
in: query
schema:
$ref: ./schemas/StoreID.yaml

Check warning on line 849 in openapi/components/parameters.yaml

View workflow job for this annotation

GitHub Actions / lint

oas3-parameter-description

Parameter objects must have "description".
storeView:
name: fetch
required: false
in: query
schema:
$ref: ./schemas/StoreView.yaml

Check warning on line 855 in openapi/components/parameters.yaml

View workflow job for this annotation

GitHub Actions / lint

oas3-parameter-description

Parameter objects must have "description".
submitterId:
name: submitterId
description: Must be a valid user ID.
Expand Down
2 changes: 2 additions & 0 deletions openapi/components/paths.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@
$ref: "./paths/files.yaml#/paths/~1gallery"
/groups:
$ref: "./paths/groups.yaml#/paths/~1groups"
/groups/redirect/{groupShortCodeAndDiscriminator}:
$ref: "./paths/groups.yaml#/paths/~1groups~1redirect~1{groupShortCodeAndDiscriminator}"
/groups/roleTemplates:
$ref: "./paths/groups.yaml#/paths/~1groups~1roleTemplates"
"/groups/{groupId}":
Expand Down
26 changes: 26 additions & 0 deletions openapi/components/paths/groups.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
$ref: ../responses/files/FileNotFoundError.yaml
/groups:
get:
operationId: searchGroups

Check notice on line 28 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroups.
summary: Search Group
description: Searches Groups by name or shortCode
tags:
Expand Down Expand Up @@ -63,6 +63,32 @@
$ref: ../responses/groups/GroupResponse.yaml
"401":
$ref: ../responses/MissingCredentialsError.yaml
"/groups/redirect/{groupShortCodeAndDiscriminator}":
parameters:
- $ref: ../parameters.yaml#/groupShortCodeAndDiscriminator
get:
operationId: resolveGroupShortCodeAndDiscriminator
summary: Resolve Group Short Code and Discriminator
description: |-
Resolves a group short code and discriminator to a group ID.

**Only works with the api.vrchat.cloud domain.**

Other domains respond with a redirect to this endpoint on the api.vrchat.cloud domain.
(e.g., to https://api.vrchat.cloud/api/1/groups/redirect/VRCHAT.0000)
tags:
- groups
responses:
"302":
description: Redirect to the /home/group/{groupId} URL of the group.
headers:
Location:
description: The /home/group/{groupId} URL of the group.
schema:
type: string
example: /home/group/grp_7ccb6ca3-cd36-4dab-9ab1-7bcf08d794e4
"404":
$ref: ../responses/groups/GroupNotFoundError.yaml
/groups/roleTemplates:
get:
operationId: getGroupRoleTemplates
Expand Down Expand Up @@ -96,8 +122,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupResponse.yaml

Check warning on line 126 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -111,13 +137,13 @@
requestBody:
content:
application/json:
schema:
$ref: ../requests/UpdateGroupRequest.yaml

Check warning on line 141 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupResponse.yaml

Check warning on line 146 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -129,11 +155,11 @@
tags:
- groups
parameters:
- name: hardDelete
required: false
in: query
schema:
type: boolean

Check warning on line 162 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

oas3-parameter-description

Parameter objects must have "description".
security:
- authCookie: []
responses:
Expand Down Expand Up @@ -204,7 +230,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupAuditLogEntryTypes

Check notice on line 233 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupAuditLogEntryTypes.
summary: Get Group Audit Log Entry Types
description: Returns a list of audit log entry types for which the group has entries.
tags:
Expand Down Expand Up @@ -238,8 +264,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupAuditLogListResponse.yaml

Check warning on line 268 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-title

Schema must have a non-empty title.

Check warning on line 268 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-description

Cannot be empty.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -248,7 +274,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupBans

Check notice on line 277 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupBans.
summary: Get Group Bans
description: Returns a list of banned users for a Group.
tags:
Expand Down Expand Up @@ -297,7 +323,7 @@
delete:
operationId: unbanGroupMember
summary: Unban Group Member
description: Unbans a user from a Group.

Check notice on line 326 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: Unbans, did you mean unban, unbars, or unmans?
tags:
- groups
security:
Expand Down Expand Up @@ -360,7 +386,7 @@
- $ref: ../parameters.yaml#/groupId
- $ref: ../parameters.yaml#/groupGalleryId
get:
operationId: getGroupGalleryImages

Check notice on line 389 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupGalleryImages.
summary: Get Group Gallery Images
description: Returns a list of images for a Group gallery.
tags:
Expand Down Expand Up @@ -489,7 +515,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupInstances

Check notice on line 518 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupInstances.
summary: Get Group Instances
description: Returns a list of group instances
tags:
Expand All @@ -497,8 +523,8 @@
security:
- authCookie: []
responses:
"200":
$ref: ../responses/groups/GroupInstanceListResponse.yaml

Check notice on line 527 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: unknownplatform.

Check notice on line 527 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-typos

Unknown word: standalonewindows.
"401":
$ref: ../responses/MissingCredentialsError.yaml
"404":
Expand All @@ -507,7 +533,7 @@
parameters:
- $ref: ../parameters.yaml#/groupId
get:
operationId: getGroupInvites

Check notice on line 536 in openapi/components/paths/groups.yaml

View workflow job for this annotation

GitHub Actions / lint

vrc-operation-id

Operation returns an array, consider renaming to listGroupInvites.
summary: Get Group Invites Sent
description: Returns a list of members that have been invited to the Group.
tags:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
title: GroupShortCodeAndDiscriminator
type: string
example: VRCHAT.0000
Loading