weirdcat/easywish
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: tidy swagger comments

Browse Source
This commit is contained in:
Николай
2025-07-11 17:43:09 +03:00
parent c988a16783
commit 47483798e3
4 changed files with 407 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
backend/docs/swagger.json
View File

@@ -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"
],