Skip to content

Commit b3bde54

Browse files
committed
update docs
1 parent b5206dc commit b3bde54

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/docs/player-auth-api.docs.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ const PlayerAuthAPIDocs: APIDocs<PlayerAuthAPIService> = {
249249
body: {
250250
currentPassword: 'The current password of the player',
251251
verificationEnabled: 'The new verification status for the player account',
252-
email: 'Required when enabling verification. This is also used for password resets: players without an email cannot reset their password'
252+
email: 'Required when attempting to enable verification if the player does not currently have an email address set'
253253
}
254254
},
255255
samples: [
@@ -261,12 +261,19 @@ const PlayerAuthAPIDocs: APIDocs<PlayerAuthAPIService> = {
261261
}
262262
},
263263
{
264-
title: 'Sample request (enabling verification)',
264+
title: 'Sample request (enabling verification, player does not have an email address)',
265265
sample: {
266266
currentPassword: 'password',
267267
email: 'boz@mail.com',
268268
verificationEnabled: true
269269
}
270+
},
271+
{
272+
title: 'Sample request (enabling verification, player has an email address)',
273+
sample: {
274+
currentPassword: 'password',
275+
verificationEnabled: true
276+
}
270277
}
271278
]
272279
}

0 commit comments

Comments
 (0)