added api docs
This commit is contained in:
31
interface/api/verification/request/verification.yaml
Normal file
31
interface/api/verification/request/verification.yaml
Normal file
@@ -0,0 +1,31 @@
|
||||
components:
|
||||
schemas:
|
||||
VerificationCodeRequest:
|
||||
type: object
|
||||
additionalProperties: false
|
||||
required:
|
||||
- purpose
|
||||
- idempotencyKey
|
||||
properties:
|
||||
purpose:
|
||||
type: string
|
||||
description: Verification purpose, e.g. login.
|
||||
target:
|
||||
type: string
|
||||
format: email
|
||||
idempotencyKey:
|
||||
type: string
|
||||
|
||||
CodeVerificationRequest:
|
||||
allOf:
|
||||
- $ref: ./verification.yaml#/components/schemas/VerificationCodeRequest
|
||||
- type: object
|
||||
additionalProperties: false
|
||||
required:
|
||||
- code
|
||||
- sessionIdentifier
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
sessionIdentifier:
|
||||
$ref: ../../../models/auth/session_identifier.yaml#/components/schemas/SessionIdentifier
|
||||
Reference in New Issue
Block a user