Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-16 20:26:19 -05:00
Code Issues Activity

chore(core): add verficiation code api doc descriptions (#5021)

Browse source
This commit is contained in:
Xiao Yijun 2023-12-01 11:03:50 +08:00 committed by GitHub
parent 65306682ec
commit ca50a78924
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
packages/core/src/routes/verification-code.openapi.json Normal file
View file

@ -0,0 +1,38 @@
{
"tags": [
{
"name": "Verification codes",
"description": "Endpoints for handling verification codes.\n\nNote: before you call the endpoints, you need to setup your email/SMS connector first."
}
],
"paths": {
"/api/verification-codes": {
"post": {
"summary": "Request and send a verification code",
"description": "Request a verification code for the provided identifier (email/phone).\nif you're using email as the identifier, you need to setup your email connector first.\nif you're using phone as the identifier, you need to setup your SMS connector first.",
"responses": {
"204": {
"description": "Verification code requested and sent successfully."
},
"400": {
"description": "Bad request. The payload may be invalid."
}
}
}
},
"/api/verification-codes/verify": {
"post": {
"summary": "Verify a verification code",
"description": "Verify a verification code for a specified identifier.\nif you're using email as the identifier, you need to setup your email connector first.\nif you're using phone as the identifier, you need to setup your SMS connector first.",
"responses": {
"204": {
"description": "Verification code verified successfully."
},
"400": {
"description": "Bad request. The payload may be invalid."
}
}
}
}
}
}