Skip to content

Commit d005cb3

Browse files
Fix mistakes, add delete totp pending, change descriptions
Added `DELETE /auth/twofactorauth/totp/pending` Fixed `POST /auth/user/resendEmail` request path Removed `POST /auth/user/resendEmail` empty request body Marked `POST /auth/register` as deprecated Changed descriptions for endpoints
1 parent 911f959 commit d005cb3

4 files changed

Lines changed: 34 additions & 18 deletions

File tree

openapi/components/codeSamples/authentication.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,11 @@
2828
curl -X POST "https://api.vrchat.cloud/api/1/auth/register" \
2929
-H "Content-Type: application/json" \
3030
--data '{"username": "{userAndDisplayName}", "password": "{password}", "email": "{emailAddress}", "year": "{birthYear}", "month": "{birthMonth}", "day": "{birthDay}", "captchaCode": "{captchaCode}", "subscribe": true, "acceptedTOSVersion": 10}'
31-
/auth/resendEmail:
31+
/auth/user/resendEmail:
3232
post:
3333
- lang: cURL
3434
source: >-
35-
curl -X POST "https://api.vrchat.cloud/api/1/auth/resendEmail" \
36-
-H "Content-Type: application/json" \
37-
--data '{}'
35+
curl -X POST "https://api.vrchat.cloud/api/1/auth/user/resendEmail"
3836
/auth/confirmEmail:
3937
get:
4038
- lang: cURL
@@ -65,6 +63,11 @@
6563
source: >-
6664
curl -X POST "https://api.vrchat.cloud/api/1/auth/twofactorauth/totp/pending" \
6765
-b "auth={authCookie}"
66+
delete:
67+
- lang: cURL
68+
source: >-
69+
curl -X DELETE "https://api.vrchat.cloud/api/1/auth/twofactorauth/totp/pending" \
70+
-b "auth={authCookie}"
6871
/auth/twofactorauth/totp/pending/verify:
6972
post:
7073
- lang: cURL

openapi/components/paths.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
$ref: "./paths/authentication.yaml#/paths/~1users~1{userId}~1delete"
3131
"/auth/register":
3232
$ref: "./paths/authentication.yaml#/paths/~1auth~1register"
33-
"/auth/resendEmail":
34-
$ref: "./paths/authentication.yaml#/paths/~1auth~1resendEmail"
33+
"/auth/user/resendEmail":
34+
$ref: "./paths/authentication.yaml#/paths/~1auth~1user~1resendEmail"
3535
"/auth/confirmEmail":
3636
$ref: "./paths/authentication.yaml#/paths/~1auth~1confirmEmail"
3737
"/auth/verifyLoginPlace":

openapi/components/paths/authentication.yaml

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,22 @@ paths:
129129
security:
130130
- authCookie: []
131131
parameters: []
132+
delete:
133+
summary: Cancel pending enabling of time-based 2FA codes
134+
operationId: cancelPending2FA
135+
x-codeSamples:
136+
$ref: "../codeSamples/authentication.yaml#/~1auth~1twofactorauth~1totp~1pending/delete"
137+
responses:
138+
'200':
139+
$ref: ../responses/authentication/Disable2FAResponse.yaml
140+
'401':
141+
$ref: ../responses/MissingCredentialsError.yaml
142+
description: Cancels the sequence for enabling time-based 2FA.
143+
tags:
144+
- authentication
145+
security:
146+
- authCookie: []
147+
parameters: []
132148
/auth/twofactorauth/totp/pending/verify:
133149
post:
134150
summary: Verify Pending 2FA code
@@ -258,7 +274,12 @@ paths:
258274
/auth/register:
259275
post:
260276
summary: Register User Account
261-
description: Verify whether the currently provided Auth Token is valid.
277+
description: |-
278+
~~Register a new user account.~~
279+
280+
**DEPRECATED:** Automated creation of accounts has no legitimate public third-party use case, and would be in violation of ToS §13.2:
281+
*By using the Platform, you agree not to: i. [...] use the Platform in a manner inconsistent with individual human usage*
282+
This endpoint is documented in the interest of completeness
262283
requestBody:
263284
required: true
264285
content:
@@ -274,16 +295,11 @@ paths:
274295
parameters: []
275296
tags:
276297
- authentication
277-
/auth/resendEmail:
298+
deprecated: true
299+
/auth/user/resendEmail:
278300
post:
279301
summary: Resend Email Confirmation
280-
description: Verify whether the currently provided Auth Token is valid.
281-
requestBody:
282-
required: true
283-
content:
284-
application/json:
285-
schema:
286-
$ref: ../requests/ResendEmailConfirmationRequest.yaml
302+
description: Requests a resend of pending email address confirmation email
287303
responses:
288304
'200':
289305
$ref: ../responses/authentication/ResendVerificationEmailSuccess.yaml

openapi/components/requests/ResendEmailConfirmationRequest.yaml

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)