Skip to content
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

Merged
merged 5 commits into from
Sep 1, 2017

Conversation

fschiettecatte
Copy link
Contributor

@fschiettecatte fschiettecatte commented Aug 5, 2017

Pull Request for heartbeat into 1.1 - issue #116

Created the heartbeat endpoint spec.
@fschiettecatte fschiettecatte changed the title Pull Request for heartbeat into 1.1 Issue #116: Pull Request for heartbeat into 1.1 Aug 5, 2017
@fschiettecatte fschiettecatte modified the milestone: v1.1 Aug 5, 2017
@Relequestual
Copy link
Member

Should we mention that:
The HTTP response code should be 200?
The response may not be JSON if the service is offline?

Just to make those who are not primarily developers aware.

Added response code section as per @Relequestual request.
@fschiettecatte
Copy link
Contributor Author

@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
Copy link
Member

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
@fschiettecatte fschiettecatte merged commit ad9d39d into release/v1.1 Sep 1, 2017
@fschiettecatte fschiettecatte deleted the issue-116 branch September 1, 2017 00:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants