add: Health endpoint documentation#613
Conversation
Signed-off-by: i567488 <kalin.tonev@sap.com>
Signed-off-by: Taylor Silva <dev@taydev.net>
taylorsilva
left a comment
taylorsilva
left a comment
There was a problem hiding this comment.
LGTM - Added a commit changing a few minor things.
Will merge once concourse/concourse#9640 is merged and we're sure the docs here conform with the output of the fly health command.
Thanks for the quick reviews! |
| ``` | ||
| HTTP 333 Degraded | ||
| ``` |
There was a problem hiding this comment.
Was reviewing concourse/concourse#9640 and noticed the client code didn't handle an HTTP 333 response. I then realized I don't recall this status code being a thing in the original PR. I looked at the health endpoint handler and I'm not seeing where we return HTTP 333: https://github.com/concourse/concourse/blob/master/atc/api/healthserver/health.go
I don't think HTTP status codes were discussed in the RFC as well, which is fine. This section here should be updated to reflect the code OR the code should be updated to reflect the docs here. I'm a bit worried about returning a non-standard HTTP status code, so updating the docs to reflect the fact that we actually return HTTP 200 here is probably what we should do.
There was a problem hiding this comment.
Yes, I just forgot to fix this I guess. I had some stuff noted down during testing different approaches and reading trough articles and pushed an older version of the docs, not the final one. Silly me, good catch. There were also other things that were not from the latest health service merged. I will commit the most recent version. Sorry for the noise.
Signed-off-by: i567488 <kalin.tonev@sap.com>
2 participants
Follow-up from concourse/concourse#9588