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

chore: updated docs

Browse Source
This commit is contained in:
Николай
2025-07-06 14:03:55 +03:00
parent bc9f5c6d3c
commit 8588a17928
3 changed files with 17 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
backend/docs/docs.go
View File

@@ -141,7 +141,10 @@ const docTemplate = `{
],
"responses": {
"200": {
"description": "desc"
"description": "Account is created and awaiting verification"
},
"409": {
"description": "Username or email is already taken"
}
}
}
@@ -362,13 +365,10 @@ const docTemplate = `{
"type": "string"
},
"password": {
"description": "TODO: password checking",
"type": "string"
},
"username": {
"type": "string",
"maxLength": 20,
"minLength": 3
"type": "string"
}
}
},
@@ -380,21 +380,14 @@ const docTemplate = `{
"verification_code"
],
"properties": {
"avatar_url": {
"type": "string",
"maxLength": 255
},
"birthday": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 75
"type": "string"
},
"username": {
"type": "string",
"maxLength": 20,
"minLength": 3
"type": "string"
},
"verification_code": {
"type": "string"

21
backend/docs/swagger.json
View File

@@ -137,7 +137,10 @@
],
"responses": {
"200": {
"description": "desc"
"description": "Account is created and awaiting verification"
},
"409": {
"description": "Username or email is already taken"
}
}
}
@@ -358,13 +361,10 @@
"type": "string"
},
"password": {
"description": "TODO: password checking",
"type": "string"
},
"username": {
"type": "string",
"maxLength": 20,
"minLength": 3
"type": "string"
}
}
},
@@ -376,21 +376,14 @@
"verification_code"
],
"properties": {
"avatar_url": {
"type": "string",
"maxLength": 255
},
"birthday": {
"type": "string"
},
"name": {
"type": "string",
"maxLength": 75
"type": "string"
},
"username": {
"type": "string",
"maxLength": 20,
"minLength": 3
"type": "string"
},
"verification_code": {
"type": "string"

13
backend/docs/swagger.yaml
View File

@@ -32,11 +32,8 @@ definitions:
email:
type: string
password:
description: 'TODO: password checking'
type: string
username:
maxLength: 20
minLength: 3
type: string
required:
- password
@@ -44,17 +41,11 @@ definitions:
type: object
models.RegistrationCompleteRequest:
properties:
avatar_url:
maxLength: 255
type: string
birthday:
type: string
name:
maxLength: 75
type: string
username:
maxLength: 20
minLength: 3
type: string
verification_code:
type: string
@@ -157,7 +148,9 @@ paths:
- application/json
responses:
"200":
description: desc
description: Account is created and awaiting verification
"409":
description: Username or email is already taken
summary: Register an account
tags:
- Auth