-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Issue #116: Pull Request for heartbeat into 1.1 #142
Conversation
Created the heartbeat endpoint spec.
Should we mention that: Just to make those who are not primarily developers aware. |
Added response code section as per @Relequestual request.
@Relequestual - sure, and done. |
DECIPHER will return content on an offline 500 response for example.
| HTTP Status Code | Reason Phrase | Description | ||
| ---------------- | -------- | ----------- | ||
| 200 | OK | no error | | ||
| 401 | Unauthorized | invalid API key |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this a protected resource? If yes, should the authentication header be documented as well, or at least link to another place where this is documented. If not, then this status code seems misplaced.
Added reference to API Key
Added reference to API Key
Pull Request for heartbeat into 1.1 - issue #116