def on_patch(self, req, resp, user_id, session, actor):
"""
description:
Update information about the user
url_params:
user_id: the identifier of the user to update
example_request_body:
python: example_patch_body
responses:
- status_code: 204
description: The user was successfully updated
- status_code: 400
description: Input model validation error
- status_code: 401
description: Unauthorized request
- status_code: 403
description: User is not permitted to update this user
"""
query = User.active_user_query(user_id)
to_update = session.find_one(query)
to_update.update(actor, **req.media)
def on_head(self, req, resp, user_id, session, actor):
"""
description:
Check if a user exists by id
url_params:
user_id: check if the user with `user_id` exists
responses:
- status_code: 204
description: The requested user exists
- status_code: 404
description: The requested user does not exist
- status_code: 401
description: Unauthorized request
- status_code: 403
description: User is not permitted to access this user
"""
try:
head_entity(resp, session, User.active_user_query(user_id))
except falcon.HTTPNotFound:
# try to fetch by user name
user_name = user_id
head_entity(resp, session, User.active_username_query(user_name))
def on_get(self, req, resp, user_id, session, actor):
"""
description:
Fetch an individual user by id. Some details, such as email, are
only included when users fetch their own record
url_params:
user_id: the identifier of the user to fetch
responses:
- status_code: 200
description: Successfully fetched a user
example:
python: get_model_example
- status_code: 404
description: Provided an invalid user id
- status_code: 401
description: Unauthorized request
- status_code: 403
description: User is not permitted to access this user
"""
try:
user = get_entity(
resp,
session,
actor,
User.active_user_query(user_id),
add_links=self.add_links)
except EntityNotFoundError:
# try to fetch by user name
user_name = user_id
user = get_entity(
resp,
session,
actor,
User.active_username_query(user_name),
add_links=self.add_links)
resp.set_header('Location', '/users/{id}'.format(**user))
