chore: tidy swagger comments;
feat: password reset models; feat: verification code validator
This commit is contained in:
@@ -52,7 +52,7 @@ const docTemplate = `{
|
||||
"summary": "Acquire tokens via login credentials (and 2FA code if needed)",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@@ -63,10 +63,13 @@ const docTemplate = `{
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.LoginResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Invalid login credentials"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -83,7 +86,25 @@ const docTemplate = `{
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Request password reset email",
|
||||
"responses": {}
|
||||
"parameters": [
|
||||
{
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.PasswordResetBeginRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Reset code sent to the email if it is attached to an account"
|
||||
},
|
||||
"429": {
|
||||
"description": "Too many recent requests for this email"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/passwordResetComplete": {
|
||||
@@ -97,8 +118,29 @@ const docTemplate = `{
|
||||
"tags": [
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Complete password reset with email code and provide 2FA code or backup code if needed",
|
||||
"responses": {}
|
||||
"summary": "Complete password reset via email code",
|
||||
"parameters": [
|
||||
{
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.PasswordResetCompleteRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.PasswordResetCompleteResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Wrong verification code or username"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/refresh": {
|
||||
@@ -113,7 +155,28 @@ const docTemplate = `{
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Receive new tokens via refresh token",
|
||||
"responses": {}
|
||||
"parameters": [
|
||||
{
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.RefreshRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.RefreshResponse"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Invalid refresh token"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/registrationBegin": {
|
||||
@@ -130,7 +193,7 @@ const docTemplate = `{
|
||||
"summary": "Register an account",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@@ -145,6 +208,9 @@ const docTemplate = `{
|
||||
},
|
||||
"409": {
|
||||
"description": "Username or email is already taken"
|
||||
},
|
||||
"429": {
|
||||
"description": "Too many recent registration attempts for this email"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -163,7 +229,7 @@ const docTemplate = `{
|
||||
"summary": "Confirm with code, finish creating the account",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@@ -174,10 +240,13 @@ const docTemplate = `{
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.RegistrationCompleteResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Invalid email or verification code"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -354,9 +423,76 @@ const docTemplate = `{
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.PasswordResetBeginRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email"
|
||||
],
|
||||
"properties": {
|
||||
"email": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.PasswordResetCompleteRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email",
|
||||
"password",
|
||||
"verification_code"
|
||||
],
|
||||
"properties": {
|
||||
"email": {
|
||||
"type": "string"
|
||||
},
|
||||
"log_out_accounts": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"password": {
|
||||
"type": "string"
|
||||
},
|
||||
"verification_code": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.PasswordResetCompleteResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"access_token": {
|
||||
"type": "string"
|
||||
},
|
||||
"refresh_token": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.RefreshRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"refresh_token"
|
||||
],
|
||||
"properties": {
|
||||
"refresh_token": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.RefreshResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"access_token": {
|
||||
"type": "string"
|
||||
},
|
||||
"refresh_token": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.RegistrationBeginRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email",
|
||||
"password",
|
||||
"username"
|
||||
],
|
||||
|
||||
@@ -48,7 +48,7 @@
|
||||
"summary": "Acquire tokens via login credentials (and 2FA code if needed)",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@@ -59,10 +59,13 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.LoginResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Invalid login credentials"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -79,7 +82,25 @@
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Request password reset email",
|
||||
"responses": {}
|
||||
"parameters": [
|
||||
{
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.PasswordResetBeginRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Reset code sent to the email if it is attached to an account"
|
||||
},
|
||||
"429": {
|
||||
"description": "Too many recent requests for this email"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/passwordResetComplete": {
|
||||
@@ -93,8 +114,29 @@
|
||||
"tags": [
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Complete password reset with email code and provide 2FA code or backup code if needed",
|
||||
"responses": {}
|
||||
"summary": "Complete password reset via email code",
|
||||
"parameters": [
|
||||
{
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.PasswordResetCompleteRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.PasswordResetCompleteResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Wrong verification code or username"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/refresh": {
|
||||
@@ -109,7 +151,28 @@
|
||||
"Auth"
|
||||
],
|
||||
"summary": "Receive new tokens via refresh token",
|
||||
"responses": {}
|
||||
"parameters": [
|
||||
{
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.RefreshRequest"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.RefreshResponse"
|
||||
}
|
||||
},
|
||||
"401": {
|
||||
"description": "Invalid refresh token"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/auth/registrationBegin": {
|
||||
@@ -126,7 +189,7 @@
|
||||
"summary": "Register an account",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@@ -141,6 +204,9 @@
|
||||
},
|
||||
"409": {
|
||||
"description": "Username or email is already taken"
|
||||
},
|
||||
"429": {
|
||||
"description": "Too many recent registration attempts for this email"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -159,7 +225,7 @@
|
||||
"summary": "Confirm with code, finish creating the account",
|
||||
"parameters": [
|
||||
{
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"name": "request",
|
||||
"in": "body",
|
||||
"required": true,
|
||||
@@ -170,10 +236,13 @@
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "desc",
|
||||
"description": " ",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/models.RegistrationCompleteResponse"
|
||||
}
|
||||
},
|
||||
"403": {
|
||||
"description": "Invalid email or verification code"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -350,9 +419,76 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.PasswordResetBeginRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email"
|
||||
],
|
||||
"properties": {
|
||||
"email": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.PasswordResetCompleteRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email",
|
||||
"password",
|
||||
"verification_code"
|
||||
],
|
||||
"properties": {
|
||||
"email": {
|
||||
"type": "string"
|
||||
},
|
||||
"log_out_accounts": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"password": {
|
||||
"type": "string"
|
||||
},
|
||||
"verification_code": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.PasswordResetCompleteResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"access_token": {
|
||||
"type": "string"
|
||||
},
|
||||
"refresh_token": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.RefreshRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"refresh_token"
|
||||
],
|
||||
"properties": {
|
||||
"refresh_token": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.RefreshResponse": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"access_token": {
|
||||
"type": "string"
|
||||
},
|
||||
"refresh_token": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"models.RegistrationBeginRequest": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"email",
|
||||
"password",
|
||||
"username"
|
||||
],
|
||||
|
||||
@@ -27,6 +27,49 @@ definitions:
|
||||
refresh_token:
|
||||
type: string
|
||||
type: object
|
||||
models.PasswordResetBeginRequest:
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
required:
|
||||
- email
|
||||
type: object
|
||||
models.PasswordResetCompleteRequest:
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
log_out_accounts:
|
||||
type: boolean
|
||||
password:
|
||||
type: string
|
||||
verification_code:
|
||||
type: string
|
||||
required:
|
||||
- email
|
||||
- password
|
||||
- verification_code
|
||||
type: object
|
||||
models.PasswordResetCompleteResponse:
|
||||
properties:
|
||||
access_token:
|
||||
type: string
|
||||
refresh_token:
|
||||
type: string
|
||||
type: object
|
||||
models.RefreshRequest:
|
||||
properties:
|
||||
refresh_token:
|
||||
type: string
|
||||
required:
|
||||
- refresh_token
|
||||
type: object
|
||||
models.RefreshResponse:
|
||||
properties:
|
||||
access_token:
|
||||
type: string
|
||||
refresh_token:
|
||||
type: string
|
||||
type: object
|
||||
models.RegistrationBeginRequest:
|
||||
properties:
|
||||
email:
|
||||
@@ -36,6 +79,7 @@ definitions:
|
||||
username:
|
||||
type: string
|
||||
required:
|
||||
- email
|
||||
- password
|
||||
- username
|
||||
type: object
|
||||
@@ -86,7 +130,7 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- description: desc
|
||||
- description: ' '
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
@@ -96,9 +140,11 @@ paths:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: desc
|
||||
description: ' '
|
||||
schema:
|
||||
$ref: '#/definitions/models.LoginResponse'
|
||||
"403":
|
||||
description: Invalid login credentials
|
||||
summary: Acquire tokens via login credentials (and 2FA code if needed)
|
||||
tags:
|
||||
- Auth
|
||||
@@ -106,9 +152,20 @@ paths:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- description: ' '
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/models.PasswordResetBeginRequest'
|
||||
produces:
|
||||
- application/json
|
||||
responses: {}
|
||||
responses:
|
||||
"200":
|
||||
description: Reset code sent to the email if it is attached to an account
|
||||
"429":
|
||||
description: Too many recent requests for this email
|
||||
summary: Request password reset email
|
||||
tags:
|
||||
- Auth
|
||||
@@ -116,20 +173,45 @@ paths:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- description: ' '
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/models.PasswordResetCompleteRequest'
|
||||
produces:
|
||||
- application/json
|
||||
responses: {}
|
||||
summary: Complete password reset with email code and provide 2FA code or backup
|
||||
code if needed
|
||||
responses:
|
||||
"200":
|
||||
description: ' '
|
||||
schema:
|
||||
$ref: '#/definitions/models.PasswordResetCompleteResponse'
|
||||
"403":
|
||||
description: Wrong verification code or username
|
||||
summary: Complete password reset via email code
|
||||
tags:
|
||||
- Auth
|
||||
/auth/refresh:
|
||||
post:
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- description: ' '
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
schema:
|
||||
$ref: '#/definitions/models.RefreshRequest'
|
||||
produces:
|
||||
- application/json
|
||||
responses: {}
|
||||
responses:
|
||||
"200":
|
||||
description: ' '
|
||||
schema:
|
||||
$ref: '#/definitions/models.RefreshResponse'
|
||||
"401":
|
||||
description: Invalid refresh token
|
||||
summary: Receive new tokens via refresh token
|
||||
tags:
|
||||
- Auth
|
||||
@@ -138,7 +220,7 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- description: desc
|
||||
- description: ' '
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
@@ -151,6 +233,8 @@ paths:
|
||||
description: Account is created and awaiting verification
|
||||
"409":
|
||||
description: Username or email is already taken
|
||||
"429":
|
||||
description: Too many recent registration attempts for this email
|
||||
summary: Register an account
|
||||
tags:
|
||||
- Auth
|
||||
@@ -159,7 +243,7 @@ paths:
|
||||
consumes:
|
||||
- application/json
|
||||
parameters:
|
||||
- description: desc
|
||||
- description: ' '
|
||||
in: body
|
||||
name: request
|
||||
required: true
|
||||
@@ -169,9 +253,11 @@ paths:
|
||||
- application/json
|
||||
responses:
|
||||
"200":
|
||||
description: desc
|
||||
description: ' '
|
||||
schema:
|
||||
$ref: '#/definitions/models.RegistrationCompleteResponse'
|
||||
"403":
|
||||
description: Invalid email or verification code
|
||||
summary: Confirm with code, finish creating the account
|
||||
tags:
|
||||
- Auth
|
||||
|
||||
Reference in New Issue
Block a user