README.md in flapjack-diner-1.0.0.rc1 vs README.md in flapjack-diner-1.0.0.rc2
- old
+ new
@@ -1,24 +1,29 @@
# Flapjack::Diner
[![Travis CI Status][id_travis_img]][id_travis_link]
-[id_travis_link]: https://secure.travis-ci.org/#!/flpjck/flapjack-diner
-[id_travis_img]: https://secure.travis-ci.org/flpjck/flapjack-diner.png
+[id_travis_link]: https://travis-ci.org/flapjack/flapjack-diner
+[id_travis_img]: https://travis-ci.org/flapjack/flapjack-diner.png
-Access the API of a [Flapjack](http://flapjack-project.com/) system monitoring server.
+Access the JSON API of a [Flapjack](http://flapjack.io/) system monitoring server.
+Note that flapjack-diner [releases](https://github.com/flapjack/flapjack-diner/releases) after [1.0.0.rc1](https://github.com/flapjack/flapjack-diner/releases/tag/v1.0.0.rc1) require the [JSONAPI](http://flapjack.io/docs/jsonapi) gateway of Flapjack to connect to. All previous releases (0.x) require the older [API](http://flapjack.io/docs/0.9/API) Flapjack gateway.
+
+
## Installation
Add this line to your application's Gemfile:
- gem 'flapjack-diner', :git => 'git://github.com/flpjck/flapjack-diner.git'
+ gem 'flapjack-diner', :github => 'flapjack/flapjack-diner'
And then execute:
$ bundle
+Note, you can also install from [RubyGems.org](https://rubygems.org/gems/flapjack-diner) as usual.
+
## Usage
Set the URI of the Flapjack server:
```ruby
@@ -29,10 +34,16 @@
```ruby
Flapjack::Diner.logger = Logger.new('logs/flapjack_diner.log')
```
+If you want the old behaviour wrt returning hashes with keys as strings (they're now symbols by default) then:
+
+```ruby
+Flapjack::Diner.return_keys_as_strings = true
+```
+
## Functions
Parameters for all of **flapjack-diner**'s functions are organised into three categories:
* Ids -- One or more String or Integer values
@@ -85,10 +96,12 @@
* [create_test_notifications_entities](#create_test_notifications_entities)
### Checks
+* [checks](#checks)
+
* [create_scheduled_maintenances_checks](#create_scheduled_maintenances_checks)
* [delete_scheduled_maintenances_checks](#delete_scheduled_maintenances_checks)
* [create_unscheduled_maintenances_checks](#create_unscheduled_maintenances_checks)
* [update_unscheduled_maintenances_checks](#update_unscheduled_maintenances_checks)
@@ -534,9 +547,22 @@
:summary => STRING
}
```
Returns true if creation succeeded or false if creation failed.
+
+---
+
+<a name="checks"> </a>
+### checks
+
+Return basic identity data for one, some or all checks. (Check ids are composed by joining together the check's entity's name, the character ':' and the check's name.)
+
+```ruby
+check = Flapjack::Diner.check(ID)
+some_checks = Flapjack::Diner.checks(ID1, ID2, ...)
+all_checks = Flapjack::Diner.checks
+```
---
<a name="create_scheduled_maintenances_checks"> </a>
### create_scheduled_maintenances_checks