Improve docs for AdminServlet et al
#1905
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
joschi
reviewed
May 3, 2021
There was a problem hiding this comment.
@mschechter-bellese Thanks for the awesome contribution! ❤️
docs/source/manual/servlets.rst
Outdated
| @@ -14,12 +14,52 @@ HealthCheckServlet | |||
| ``HealthCheckServlet`` responds to ``GET`` requests by running all the [health checks](#health-checks) | |||
| and returning ``501 Not Implemented`` if no health checks are registered, ``200 OK`` if all pass, or | |||
| ``500 Internal Service Error`` if one or more fail. The results are returned as a human-readable | |||
| ``text/plain`` entity. | |||
| ``application/json`` entity. | |||
There was a problem hiding this comment.
Maybe we could just write "as a human-readable JSON entity"?
Suggested change
| ``application/json`` entity. | |
| JSON entity. |
There was a problem hiding this comment.
Updated - thanks!
docs/source/manual/servlets.rst
Outdated
Comment on lines
58
to
60
| * ``httpStatusIndicator`` (`Boolean``): Determines whether the HTTP status code is used to | ||
| determine whether the application is healthy; if not provided, it defaults to the value from the | ||
| initialization parameter |
There was a problem hiding this comment.
Could we describe the possible HTTP response codes (200, 500, 501)?
There was a problem hiding this comment.
They're in the lead paragraph; I split them out for clarity
joschi
approved these changes
May 4, 2021
joschi
changed the title
AdminServlet et al
You're welcome - glad to help out! I probably should have done this on my previous issue :) Next up is getting these changes integrated into Dropwizard via |
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.
Added documentation for the
AdminServletand the other metrics-provided servlets, including the new configuration added as part of #1890.Resolves #1896