49 lines
1.5 KiB
YAML
49 lines
1.5 KiB
YAML
/users/signup:
|
|
post:
|
|
tags:
|
|
- 'users'
|
|
summary: 'Signup the user'
|
|
description: 'Allows a new user to signup, if success he would need to confirm his email.'
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: 'object'
|
|
properties:
|
|
email:
|
|
type: 'string'
|
|
format: 'email'
|
|
name:
|
|
type: 'string'
|
|
minLength: 3
|
|
maxLength: 30
|
|
example: 'user'
|
|
password:
|
|
type: 'string'
|
|
format: 'password'
|
|
example: 'password'
|
|
language:
|
|
allOf:
|
|
- $ref: '#/definitions/Language'
|
|
theme:
|
|
allOf:
|
|
- $ref: '#/definitions/Theme'
|
|
required:
|
|
- 'email'
|
|
- 'name'
|
|
- 'password'
|
|
parameters:
|
|
- name: 'redirectURI'
|
|
description: 'The redirect URI to redirect the user when he successfuly confirm his email (could be a signin page), if not provided it will redirect the user to a simple page with a message to tell the user he can now signin.'
|
|
in: 'query'
|
|
required: false
|
|
responses:
|
|
allOf:
|
|
- $ref: '#/definitions/BadRequestError'
|
|
- '201':
|
|
description: 'User created and send an email to confirm the account'
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/definitions/User'
|