search

flapjack / flapjack-diner

Consumer of the Flapjack API
http://flapjack.io/
MIT License
17 stars 10 forks source link

"Flapjack::Diner.checks" apparently does nothing #38

Closed ghicks-rmn closed 9 years ago

ghicks-rmn commented 9 years ago

README.md lists a checks method that will return all checks, or a specific set if IDs are passed to it as arguments. I've tried running it both ways, and all that gets returned is a blank line.

The Flapjack JSON API docs don't list an endpoint for GETting checks - is this another leftover from before the JSON API was added?

ghost commented 9 years ago

The JSONAPI docs are outdated in that sense -- the endpoint is there -- but the /checks endpoint can be a bit fiddly/counter-intuitive, as for historical reasons it's only returning checks that have received events in the past. We've been trying to clean up the API interfaces to ensure consistent behaviour, but not everything is across the line in that regard yet, sorry.

Sarah-E-Greene commented 9 years ago

This has been replaced by Flapjack::Diner.status_report_entities. @ali-graham, are you OK with me taking this out of the readme?

ghost commented 9 years ago

The readme should still contain the checks method, for symmetry with the JSONAPI endpoints.

ghost commented 9 years ago

Assigning this to myself to check whether we've improved this for the 1.2 release (I think we have) and clear up the docs if so.

ghost commented 9 years ago

This should work as documented in Flapjack v1.2, after https://github.com/flapjack/flapjack/pull/682 (so really a side-effect of some other work, with an eye to making the data better reflect what's being modelled). Closing, but please re-open after that's been released if the situation hasn't improved for you.