Table of Contents
Module author: Roy Russo <royrusso.gmail.com>
elastichq.common.api_response.
APIResponse
(data, status_code=200, headers=None, message=None)[source]¶Uniform response envelope
Parameters: |
|
---|---|
Returns: | A Flask-RESTFul response |
All ElasticHQ API endpoints are wrapped by a decorator that handles raised exceptions.
elastichq.common.exceptions.
request_wrapper
(functor, message='Oops! Something bad happened.')[source]¶Standardizes error handling across the app
Parameters: | functor – |
---|---|
Returns: |
elastichq.common.exceptions.
ApiException
(message, status_code=500)[source]¶Generic API parser/formatter for exception messages.
Parameters: |
|
---|
elastichq.common.exceptions.
NotFoundException
(message, status_code=404)[source]¶Responsible for returning HTTP 404
Parameters: |
|
---|