Skip to content

Commit 915785f

Browse files
groups redirect
1 parent 28d7d89 commit 915785f

4 files changed

Lines changed: 36 additions & 0 deletions

File tree

openapi/components/parameters.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,13 @@ groupByDuration:
315315
schema:
316316
type: string
317317
example: days
318+
groupShortCodeAndDiscriminator:
319+
name: groupShortCodeAndDiscriminator
320+
description: Must be a valid group short code and discriminator.
321+
required: true
322+
in: path
323+
schema:
324+
$ref: ./schemas/GroupShortCodeAndDiscriminator.yaml
318325
groupGalleryId:
319326
name: groupGalleryId
320327
description: Must be a valid group gallery ID.

openapi/components/paths.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@
172172
$ref: "./paths/files.yaml#/paths/~1gallery"
173173
/groups:
174174
$ref: "./paths/groups.yaml#/paths/~1groups"
175+
/groups/redirect/{groupShortCodeAndDiscriminator}:
176+
$ref: "./paths/groups.yaml#/paths/~1groups~1redirect~1{groupShortCodeAndDiscriminator}"
175177
/groups/roleTemplates:
176178
$ref: "./paths/groups.yaml#/paths/~1groups~1roleTemplates"
177179
"/groups/{groupId}":

openapi/components/paths/groups.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,30 @@ paths:
6363
$ref: ../responses/groups/GroupResponse.yaml
6464
"401":
6565
$ref: ../responses/MissingCredentialsError.yaml
66+
"/groups/redirect/{groupShortCodeAndDiscriminator}":
67+
get:
68+
operationId: resolveGroupShortCodeAndDiscriminator
69+
summary: Resolve Group Short Code and Discriminator
70+
description: |-
71+
Resolves a group short code and discriminator to a group ID.
72+
73+
**Only works with the api.vrchat.cloud domain.**
74+
75+
Other domains respond with a redirect to this endpoint on the api.vrchat.cloud domain.
76+
(e.g., to https://api.vrchat.cloud/api/1/groups/redirect/VRCHAT.0000)
77+
tags:
78+
- groups
79+
responses:
80+
"302":
81+
description:
82+
headers:
83+
Location:
84+
description: The /home/group/{groupId} URL of the group.
85+
schema:
86+
type: string
87+
example: /home/group/grp_7ccb6ca3-cd36-4dab-9ab1-7bcf08d794e4
88+
"404":
89+
$ref: ../responses/groups/GroupNotFoundError.yaml
6690
/groups/roleTemplates:
6791
get:
6892
operationId: getGroupRoleTemplates
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
title: GroupShortCodeAndDiscriminator
2+
type: string
3+
example: "VRCHAT.0000"

0 commit comments

Comments
 (0)