Skip to content

Commit fae2465

Browse files
committed
[PATHS] /user/v1/resendWelcomeEmail, /hiddenstore/v2/unlock
[REQ_BODIES] ResendWelcomeEmailRequest, UnlockHiddenStoreRequest [SCHEMAS] UnlockHiddenStoreResponse
1 parent e3139a0 commit fae2465

File tree

1 file changed

+120
-1
lines changed

1 file changed

+120
-1
lines changed

Diff for: openapi.yaml

+120-1
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,48 @@ paths:
192192
- $ref: '#/components/schemas/Errors'
193193
- $ref: '#/components/schemas/Error'
194194

195+
/hiddenstore/v2/unlock:
196+
post:
197+
tags:
198+
- hiddenstore
199+
summary: Unlock a hidden store
200+
security:
201+
- bearerAuth: []
202+
203+
requestBody:
204+
$ref: '#/components/requestBodies/UnlockHiddenStoreRequest'
205+
206+
responses:
207+
'200':
208+
description: OK
209+
content:
210+
application/json:
211+
schema:
212+
$ref: '#/components/schemas/UnlockHiddenStoreResponse'
213+
'400':
214+
description: VALIDATION_ERROR
215+
content:
216+
application/json:
217+
schema:
218+
$ref: '#/components/schemas/Errors'
219+
'401':
220+
description: UNAUTHORIZED
221+
content:
222+
application/json:
223+
schema:
224+
oneOf:
225+
- $ref: '#/components/schemas/Errors'
226+
- $ref: '#/components/schemas/Error'
227+
'403':
228+
description: FORBIDDEN
229+
content:
230+
application/json:
231+
schema:
232+
$ref: '#/components/schemas/Errors'
233+
# happens if the given user_id doesn't match with the given bearer token
234+
# UNAUTHORIZED
235+
# Access is denied
236+
195237
/auth/v2/token/refresh:
196238
post:
197239
tags:
@@ -348,9 +390,31 @@ paths:
348390
tags:
349391
- user
350392
summary: Reset password
351-
393+
352394
requestBody:
353395
$ref: '#/components/requestBodies/ResetPasswordRequest'
396+
397+
responses:
398+
'200':
399+
description: 'OK'
400+
'400':
401+
description: VALIDATION_ERROR
402+
content:
403+
application/json:
404+
schema:
405+
$ref: '#/components/schemas/Errors'
406+
407+
/user/v1/resendWelcomeEmail:
408+
post:
409+
tags:
410+
- user
411+
summary: Resend the Welcome email
412+
security:
413+
- bearerAuth: []
414+
415+
requestBody:
416+
$ref: '#/components/requestBodies/ResendWelcomeEmailRequest'
417+
354418
responses:
355419
'200':
356420
description: 'OK'
@@ -360,6 +424,23 @@ paths:
360424
application/json:
361425
schema:
362426
$ref: '#/components/schemas/Errors'
427+
'401':
428+
description: UNAUTHORIZED
429+
content:
430+
application/json:
431+
schema:
432+
oneOf:
433+
- $ref: '#/components/schemas/Errors'
434+
- $ref: '#/components/schemas/Error'
435+
'403':
436+
description: FORBIDDEN
437+
content:
438+
application/json:
439+
schema:
440+
$ref: '#/components/schemas/Errors'
441+
# happens if the given user_id doesn't match with the given bearer token
442+
# UNAUTHORIZED
443+
# Access is denied
363444

364445
components:
365446
# Authentication
@@ -432,6 +513,35 @@ components:
432513
required:
433514
- email
434515

516+
ResendWelcomeEmailRequest:
517+
required: true
518+
content:
519+
application/json:
520+
schema:
521+
type: object
522+
properties:
523+
user_id:
524+
type: string
525+
example: "123456"
526+
required:
527+
- user_id
528+
529+
UnlockHiddenStoreRequest:
530+
required: true
531+
content:
532+
application/json:
533+
schema:
534+
type: object
535+
properties:
536+
unlock_code:
537+
type: string
538+
user_id:
539+
type: string
540+
example: "123456"
541+
required:
542+
- unlock_code
543+
- user_id
544+
435545
# Describing Responses
436546
schemas:
437547
Errors:
@@ -872,3 +982,12 @@ components:
872982
- access_token
873983
- refresh_token
874984
- startup_data
985+
986+
UnlockHiddenStoreResponse:
987+
type: object
988+
properties:
989+
state:
990+
type: string
991+
enum: [OK, CODE_INVALID, ALREADY_UNLOCKED]
992+
required:
993+
- state

0 commit comments

Comments
 (0)