self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2025-07-15 01:24:34 +02:00
Code Issues Releases Activity

Fix #3113. RESTful API was not correctly documented.

Browse Source
This commit is contained in:
Dimitri Huisman
2024-01-22 10:44:30 +00:00
parent e0c5dc5fe5
commit 8f86ffc6fd
6 changed files with 61 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
core/admin/mailu/api/v1/user.py
View File

@ -87,23 +87,23 @@ user_fields_put = api.model('UserUpdate', {
@user.route('')
class Users(Resource):
@user.doc('list_users')
@user.doc('list_user')
@user.marshal_with(user_fields_get, as_list=True, skip_none=True, mask=None)
@user.doc(security='Bearer')
@common.api_token_authorization
def get(self):
"List users"
"List all users"
return models.User.query.all()
@user.doc('create_user')
@user.expect(user_fields_post)
@user.response(200, 'Success', response_fields)
@user.response(400, 'Input validation exception')
@user.response(400, 'Input validation exception', response_fields)
@user.response(409, 'Duplicate user', response_fields)
@user.doc(security='Bearer')
@common.api_token_authorization
def post(self):
""" Create user """
""" Create a new user """
data = api.payload
if not validators.email(data['email']):
return { 'code': 400, 'message': f'Provided email address {data["email"]} is not a valid email address'}, 400
@ -168,12 +168,13 @@ class Users(Resource):
@user.route('/<string:email>')
class User(Resource):
@user.doc('find_user')
@user.marshal_with(user_fields_get, code=200, description='Success', as_list=False, skip_none=True, mask=None)
@user.response(400, 'Input validation exception', response_fields)
@user.response(404, 'User not found', response_fields)
@user.doc(security='Bearer')
@common.api_token_authorization
def get(self, email):
""" Find user """
""" Look up the specified user """
if not validators.email(email):
return { 'code': 400, 'message': f'Provided email address {email} is not a valid email address'}, 400
@ -191,7 +192,7 @@ class User(Resource):
@user.doc(security='Bearer')
@common.api_token_authorization
def patch(self, email):
""" Update user """
""" Update the specified user """
data = api.payload
if not validators.email(email):
return { 'code': 400, 'message': f'Provided email address {data["email"]} is not a valid email address'}, 400
@ -258,7 +259,7 @@ class User(Resource):
@user.doc(security='Bearer')
@common.api_token_authorization
def delete(self, email):
""" Delete user """
""" Delete the specified user """
if not validators.email(email):
return { 'code': 400, 'message': f'Provided email address {email} is not a valid email address'}, 400