feat: add http health API #763
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
niklasad1
commented
May 11, 2022
lexnv
approved these changes
May 11, 2022
jsdw
approved these changes
May 11, 2022
bkchr
reviewed
May 11, 2022
Comment on lines
+172
to
+178
| /// Enable health endpoint. | ||
| /// Allows you to expose one of the methods under GET /<path> The method will be invoked with no parameters. Error returned from the method will be converted to status 500 response. | ||
| /// Expects a tuple with (<path>, <rpc-method-name>). | ||
| pub fn health_api(mut self, path: impl Into<String>, method: impl Into<String>) -> Self { | ||
| self.health_api = Some(HealthApi { path: path.into(), method: method.into() }); | ||
| self | ||
| } |
There was a problem hiding this comment.
The docs are rather confusing. I needed to read the code to fully understand on what this is doing.
And why is the method called health_api? Couldn't this theoretically be any kind of endpoint? (which is already implicitly supported, because path can be anything)
There was a problem hiding this comment.
yepp, you are correct.
I did the fastest possible way and did the same as the jsonrpc crate does.
Sure let's open an issue and do something better.
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.
No description provided.