Document the REST API and improve error handling #114
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Handle cases when MFA is not monitored or not captured. As an exception in case of `get_captured_data` return default values (-1) if MFA is monitored but not captured as this is polled by the frontend and used as a kind of capture status. This could be improved in the future.
Currently only in edoc, but in the future it could be moved to some more declarative format (eg OpenAPI/Swagger).
afronski
approved these changes
Nov 16, 2017
izoslav
approved these changes
Nov 20, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There are a few different changes in this PR unfortunately:
Split Cowboy 1.x specific code from generic REST handler
(in preparation to support 2.x too)
Improve error handling of capture functions
Handle cases when MFA is not monitored or not captured.
As an exception in case of
get_captured_datareturn defaultvalues (-1) if MFA is monitored but not captured as this is polled by
the frontend and used as a kind of capture status. This could be
improved in the future.
Document the REST API ( Document REST API #100 )
Currently only in edoc, but in the future it could be moved to some more
declarative format (eg OpenAPI/Swagger).