flapjack-diner 2.0.0b1 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ce62bf38cc938f3b7f88f30ba160950e3e5cd1c
-  data.tar.gz: 0490002709d57e4d15b6d3ca7e71c13381177c40
+  metadata.gz: 0ca71cf066fca99781cc543fb931e950771c52bc
+  data.tar.gz: 3487411a016d2d23688a188f74462dce813aa29d
 SHA512:
-  metadata.gz: 48f6e46083c60efbd5f0b644270123aecd49d384ea73bc04200e081c906532774f6de9635fb58a5992ee6bb8eb93716e91603a5ae6a50368fd3bc3376e2e21be
-  data.tar.gz: 40a15fc6103dd47ec15aac237d983b44f8ec0ce38e4f8a184acd8de0930fa7b146b0a84c1ca20b49708ce95689600e82517516e98974df1e847aa99a34d6c490
+  metadata.gz: 6d48ca39d5c3bc2eeee576baf6f469a7afde1bfc68e67356ce076caeba28c0ef9a613157a49006c12305e5746d0a87328fa3e86340cb47eeb495241f15ea3348
+  data.tar.gz: f54b0e2abd6e8836c8d46c9328a9af2e23aa8fb19f4169787370b0a9b29102cc3704b308a470dfd9f88aef9bb0af534a97e351b402b1de6ddabbf89072a26bb5

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'lib/flapjack-diner.rb'
+
+# doesn't handle multi-file state
+Documentation:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space

data/.rubocop_todo.yml

@@ -0,0 +1,135 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+# AccessorMethodName:
+#   Enabled: false
+
+# AlignArray:
+#   Enabled: false
+
+# AlignHash:
+#   Enabled: false
+
+# AlignParameters:
+#   Enabled: false
+
+# AndOr:
+#   Enabled: false
+
+# AssignmentInCondition:
+#   Enabled: false
+
+# BlockAlignment:
+#   Enabled: false
+
+# BlockNesting:
+#   Max: 4
+
+# Blocks:
+#   Enabled: false
+
+# BracesAroundHashParameters:
+#   Enabled: false
+
+# CaseIndentation:
+#   Enabled: false
+
+# ClassLength:
+#   Max: 221
+
+# CollectionMethods:
+#   Enabled: false
+
+# CommentAnnotation:
+#   Enabled: false
+
+# CyclomaticComplexity:
+#   Max: 32
+
+# DotPosition:
+#   Enabled: false
+
+# EmptyLines:
+#   Enabled: false
+
+# EmptyLinesAroundBody:
+#   Enabled: false
+
+# EndAlignment:
+#   Enabled: false
+
+# FavorUnlessOverNegatedIf:
+#   Enabled: false
+
+# FinalNewline:
+#   Enabled: false
+
+# HashMethods:
+#   Enabled: false
+
+# IfUnlessModifier:
+#   Enabled: false
+
+# IndentationWidth:
+#   Enabled: false
+
+# LineLength:
+#   Max: 120
+
+# MethodCallParentheses:
+#   Enabled: false
+
+# MethodLength:
+#   Max: 95
+
+# MultilineBlockChain:
+#   Enabled: false
+
+# ParenthesesAroundCondition:
+#   Enabled: false
+
+# PredicateName:
+#   Enabled: false
+
+# RaiseArgs:
+#   Enabled: false
+
+# RedundantSelf:
+#   Enabled: false
+
+# RescueException:
+#   Enabled: false
+
+# Semicolon:
+#   Enabled: false
+
+# ShadowingOuterLocalVariable:
+#   Enabled: false
+
+# SpaceAfterNot:
+#   Enabled: false
+
+# SpaceAroundOperators:
+#   Enabled: false
+
+# SpaceInsideHashLiteralBraces:
+#   Enabled: false
+
+# SpaceInsideParens:
+#   Enabled: false
+
+# SpecialGlobalVars:
+#   Enabled: false
+
+# StringLiterals:
+#   Enabled: false
+
+# TrivialAccessors:
+#   Enabled: false
+
+# UselessAssignment:
+#   Enabled: false
+
+# WordArray:
+#   Enabled: false

data/.travis.yml

@@ -5,12 +5,17 @@ rvm:
 - '2.1'
 - '2.2'
 cache: bundler
-script: bundle exec rspec
+script: "bundle exec rspec"
 notifications:
   irc:
     channels:
-    - irc.freenode.net#flapjack
+      - 'irc.freenode.net#flapjack'
     template:
-    - "%{message} %{repository}#%{build_number} (%{branch} - %{commit} : %{author})"
-  slack:
-    secure: OSSVSOzOOsGV58lo88tiXQiOlFt4YeRz7yQ0r2kaGV1IFpCISbLxMPTCR6qyngGJWV/QB7cgfKs39xUiAD/bU0cqz1D8BgnhLjRKcU53CymMEWV6s/TTyCgoQy+b/7DM3d7ebvEySS7fxWtApJ/DdpqbkhcgGJbNMIpaXuWd5Ro=
+      - '%{message} %{repository}#%{build_number} (%{branch} - %{commit} : %{author})'
+  hipchat:
+    template:
+      - '%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}
+        (<a href="%{build_url}">Details</a>/<a href="%{compare_url}">Change view</a>)'
+    format: html
+    rooms:
+      secure: BfENxsVOSS6YKJn/kMr8ctXTvOvZHHlpgRN8AWshCEEaorPwFlCwlQuEYz+DSR7COjwLNZav5xnTFRaPkcCG8wc4ztMgSdv9XkrGjwJHxEEIzsjPT556LtLF4d8U2Di1MNsD6YGU7kvvzhh5hAPpEn0LBGhYlz+TCv+XCjI8/6I=

data/README.md

@@ -7,7 +7,7 @@
 
 Access the JSON API of a [Flapjack](http://flapjack.io/) system monitoring server.
 
-Please note that the following documentation refers to the `v2.0.0b1` pre-release of this gem. You may instead be looking for [documentation for the latest stable version](https://github.com/flapjack/flapjack-diner/blob/maint/1.x/README.md).
+Please note that the following documentation refers to the `v2.0.0-alpha.1` pre-release of this gem. You may instead be looking for [documentation for the latest stable version](https://github.com/flapjack/flapjack-diner/blob/maint/1.x/README.md).
 
 ## Installation
 
@@ -45,7 +45,7 @@ Flapjack::Diner.open_timeout(30)
 Flapjack::Diner.read_timeout(300)
 ```
 
-If you want the old behaviour with respect to returning hashes with keys as strings (they're now symbols by default) then:
+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
@@ -55,8 +55,8 @@ Flapjack::Diner.return_keys_as_strings = true
 
 Options for all of **flapjack-diner**'s functions are organised as either:
 
-* Ids -- One or more String or Integer values; or
-* Parameters -- One or more Hashes
+* Ids &emdash; One or more String or Integer values; or
+* Parameters &emdash; One or more Hashes
 
 While these can be passed in in any order, the convention is that they will be ordered as listed above.
 
@@ -136,12 +136,10 @@ Flapjack::Diner.create_checks(CHECK, ...)
 ```
 CHECK
 {
-  :id      => UUID_STRING,
+  :id      => STRING,
   :name    => STRING,
   :enabled => BOOLEAN,
-  :initial_failure_delay => INTEGER,
-  :repeat_failure_delay => INTEGER,
-  :tags    => [UUID_STRING, ...]
+  :tags    => [TAG_NAME, ...]
 }
 ```
 
@@ -155,8 +153,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all checks.
 
 ```ruby
-check = Flapjack::Diner.checks(UUID_STRING)
-some_checks = Flapjack::Diner.checks(UUID_STRING, UUID_STRING, ...)
+check = Flapjack::Diner.checks(CHECK_ID)
+some_checks = Flapjack::Diner.checks(CHECK_ID, CHECK_ID, ...)
 first_page_of_checks = Flapjack::Diner.checks
 ```
 
@@ -169,15 +167,15 @@ Update data for one or more checks.
 
 ```ruby
 # update values for one check
-Flapjack::Diner.update_checks(UUID_STRING, KEY => VALUE, ...)
+Flapjack::Diner.update_checks(CHECK_ID, KEY => VALUE, ...)
 
 # update values for multiple checks
-Flapjack::Diner.update_checks({UUID_STRING, KEY => VALUE, ...}, {UUID_STRING, KEY => VALUE, ...})
+Flapjack::Diner.update_checks({CHECK_ID, KEY => VALUE, ...}, {CHECK_ID, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-`:enabled`, `:name`, `:initial_failure_delay`, `:repeat_failure_delay` and `:tags`
+`:enabled`, `:name` and `:tags`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -190,10 +188,10 @@ Delete one or more checks.
 
 ```ruby
 # delete one check
-Flapjack::Diner.delete_checks(UUID_STRING)
+Flapjack::Diner.delete_checks(CHECK_ID)
 
 # delete multiple check
-Flapjack::Diner.delete_checks(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_checks(CHECK_ID, CHECK_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -214,13 +212,13 @@ Create one or more contacts.
 Flapjack::Diner.create_contacts(CONTACT, ...)
 ```
 
-```ruby
-# CONTACT
+```
+CONTACT
 {
-  :id => UUID_STRING,
+  :id => STRING,
   :name => STRING,
   :timezone => STRING,
-  :tags => [UUID_STRING, ...]
+  :tags => [TAG_NAME, ...]
 }
 ```
 
@@ -234,8 +232,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all contacts.
 
 ```ruby
-contact = Flapjack::Diner.contacts(UUID_STRING)
-some_contacts = Flapjack::Diner.contacts(UUID_STRING, UUID_STRING, ...)
+contact = Flapjack::Diner.contacts(CONTACT_ID)
+some_contacts = Flapjack::Diner.contacts(CONTACT_ID, CONTACT_ID, ...)
 first_page_of_contacts = Flapjack::Diner.contacts
 ```
 
@@ -248,10 +246,10 @@ Update data for one or more contacts.
 
 ```ruby
 # update values for one contact
-Flapjack::Diner.update_contacts(UUID_STRING, KEY => VALUE, ...)
+Flapjack::Diner.update_contacts(CONTACT_ID, KEY => VALUE, ...)
 
 # update values for multiple contacts
-Flapjack::Diner.update_contacts({UUID_STRING, KEY => VALUE, ...}, {UUID_STRING, KEY => VALUE, ...})
+Flapjack::Diner.update_contacts({CONTACT_ID, KEY => VALUE, ...}, {CONTACT_ID, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
@@ -269,10 +267,10 @@ Delete one or more contacts.
 
 ```ruby
 # delete one contact
-Flapjack::Diner.delete_contacts(UUID_STRING)
+Flapjack::Diner.delete_contacts(CONTACT_ID)
 
 # delete multiple contacts
-Flapjack::Diner.delete_contacts(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_contacts(CONTACT_ID, CONTACT_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -296,7 +294,7 @@ Flapjack::Diner.create_media(MEDIUM, MEDIUM, ...)
 ```ruby
 # MEDIUM
 {
-  :id => UUID_STRING,
+  :id => UUID,
   :transport => STRING,               # required
   :address => STRING,                 # required (context depends on transport)
   :interval => INTEGER,               # required (if transport != 'pagerduty')
@@ -304,8 +302,8 @@ Flapjack::Diner.create_media(MEDIUM, MEDIUM, ...)
   :pagerduty_subdomain => STRING,     # required (if transport == 'pagerduty')
   :pagerduty_token => STRING,         # required (if transport == 'pagerduty')
   :pagerduty_ack_duration => INTEGER, # required (if transport == 'pagerduty')
-  :contact => UUID_STRING,            # required
-  :rules => [UUID_STRING, UUID_STRING, ...]
+  :contact => CONTACT_ID,             # required
+  :rules => [RULE_ID, RULE_ID, ...]
 }
 ```
 
@@ -319,8 +317,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all notification media.
 
 ```ruby
-medium = Flapjack::Diner.media(UUID_STRING)
-some_media = Flapjack::Diner.media(UUID_STRING, UUID_STRING, ...)
+medium = Flapjack::Diner.media(MEDIUM_ID)
+some_media = Flapjack::Diner.media(MEDIUM_ID, MEDIUM_ID, ...)
 first_page_of_media = Flapjack::Diner.media
 ```
 
@@ -333,10 +331,10 @@ Update data for one or more notification media.
 
 ```ruby
 # update values for one medium
-Flapjack::Diner.update_media(UUID_STRING, KEY => VALUE, ...)
+Flapjack::Diner.update_media(MEDIUM_ID, KEY => VALUE, ...)
 
 # update values for multiple media
-Flapjack::Diner.update_media({UUID_STRING, KEY => VALUE, ...}, {UUID_STRING, KEY => VALUE, ...})
+Flapjack::Diner.update_media({MEDIUM_ID, KEY => VALUE, ...}, {MEDIUM_ID, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
@@ -354,10 +352,10 @@ Delete one or more notification media.
 
 ```ruby
 # delete one medium
-Flapjack::Diner.delete_media(UUID_STRING)
+Flapjack::Diner.delete_media(MEDIUM_ID)
 
 # delete multiple media
-Flapjack::Diner.delete_media(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_media(MEDIUM_ID, MEDIUM_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -378,21 +376,22 @@ Create one or more notification rules.
 Flapjack::Diner.create_rules(RULE, ...)
 ```
 
+**FIXME** time_restrictions data structure isn't handled yet
+
+**FIXME** should empty `conditions_list` implicitly specify blackhole -- thus
+remove the `is_blackhole` boolean?
+
 ```ruby
 # RULE
 {
-  :id                    => UUID_STRING,
-  :name                  => STRING,
-  :enabled               => BOOLEAN,
-  :blackhole             => BOOLEAN,
-  :strategy              => STRING,           # one of ['global', 'all_tags', 'any_tag', 'no_tag']
-  :conditions_list       => STRING,           # which conditions the rule will match;
-                                              #   all if empty, or comma-separated subset
-                                              #   of 'critical,warning,unknown'
-  :time_restriction_ical => STRING,
-  :contact               => UUID_STRING,      # required
-  :media                 => [UUID_STRING, ...]
-  :tags                  => [UUID_STRING, ...]
+  :id              => UUID_STRING,
+  :conditions_list => STRING,           # which conditions the rule will match;
+                                        # all if empty, or comma-separated subset
+                                        # of 'critical,warning,unknown'
+  :is_blackhole    => BOOLEAN,
+  :contact         => CONTACT_ID,       # required
+  :media           => [MEDIUM_ID, ...]
+  :tags            => [TAG_NAME, ...]
 }
 ```
 
@@ -406,8 +405,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all notification rules.
 
 ```ruby
-rule = Flapjack::Diner.rules(UUID_STRING)
-some_rules = Flapjack::Diner.rules(UUID_STRING, UUID_STRING, ...)
+rule = Flapjack::Diner.rules(RULE_ID)
+some_rules = Flapjack::Diner.rules(RULE_ID, RULE_ID, ...)
 first_page_of_rules = Flapjack::Diner.rules
 ```
 
@@ -420,15 +419,15 @@ Update data for one or more notification rules.
 
 ```ruby
 # update values for one rule
-Flapjack::Diner.update_rules(:id => UUID_STRING, KEY => VALUE, ...)
+Flapjack::Diner.update_rules(:id => RULE_ID, KEY => VALUE, ...)
 
 # update values for multiple rules
-Flapjack::Diner.update_rules({:id => UUID_STRING, KEY => VALUE, ...}, {:id => UUID_STRING, KEY => VALUE, ...})
+Flapjack::Diner.update_rules({:id => RULE_ID, KEY => VALUE, ...}, {:id => RULE_ID, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-  `:name`, `:enabled`, `:blackhole`, `:strategy`, `:conditions_list`, `:time_restrictiosn_ical`, `:media` and `:tags`
+  `:conditions_list`, `:is_blackhole`, `:media` and `:tags`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -441,10 +440,10 @@ Delete one or more notification rules.
 
 ```ruby
 # delete one rule
-Flapjack::Diner.delete_rules(UUID_STRING)
+Flapjack::Diner.delete_rules(RULE_ID)
 
 # delete multiple rules
-Flapjack::Diner.delete_rules(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_rules(RULE_ID, RULE_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -468,11 +467,10 @@ Flapjack::Diner.create_tags(TAG, ...)
 ```ruby
 # TAG
 {
-  :id        => UUID_STRING,
-  :name      => STRING,         # required
-  :checks    => [UUID_STRING, ...],
-  :contacts  => [UUID_STRING, ...],
-  :rules     => [UUID_STRING, ...]
+  :name    => STRING,         # required
+  :checks  => [CHECK_ID, ...]
+  :rules   => [RULE_ID, ...]
+}
 ```
 
 Returns false if creation failed, or the created object(s) if it succeeded.
@@ -485,8 +483,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all tags.
 
 ```ruby
-tag = Flapjack::Diner.tags(UUID_STRING)
-some_tags = Flapjack::Diner.tags(UUID_STRING, UUID_STRING, ...)
+tag = Flapjack::Diner.tags(TAG_NAME)
+some_tags = Flapjack::Diner.tags(TAG_NAME, TAG_NAME, ...)
 first_page_of_tags = Flapjack::Diner.tags
 ```
 
@@ -499,15 +497,15 @@ Update data for one or more tags.
 
 ```ruby
 # update values for one tag
-Flapjack::Diner.update_tags(:id => UUID_STRING, KEY => VALUE, ...)
+Flapjack::Diner.update_tags(:id => TAG_NAME, KEY => VALUE, ...)
 
 # update values for multiple tags
-Flapjack::Diner.update_tags({:id => UUID_STRING, KEY => VALUE, ...}, {:id => UUID_STRING, KEY => VALUE, ...})
+Flapjack::Diner.update_tags({:id => TAG_NAME, KEY => VALUE, ...}, {:id => TAG_NAME, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
 
-  `:checks`, `:contacts` and `:rules`
+  `:checks` and `:rules`
 
 Returns true if updating succeeded or false if updating failed.
 
@@ -520,10 +518,10 @@ Delete one or more tags.
 
 ```ruby
 # delete one tag
-Flapjack::Diner.delete_tags(UUID_STRING)
+Flapjack::Diner.delete_tags(TAG_NAME)
 
 # delete multiple tags
-Flapjack::Diner.delete_tags(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_tags(TAG_NAME, TAG_NAME, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -547,12 +545,12 @@ Flapjack::Diner.create_scheduled_maintenances(SCHEDULED_MAINTENANCE, ...)
 ```ruby
 SCHEDULED_MAINTENANCE
 {
-  :id => UUID_STRING,
+  :id => UUID,
   :start_time => DATETIME, # required
   :end_time => DATETIME,   # required
   :summary => STRING,
-  :check => UUID_STRING,   # one (and only one) of :check or :tag must be provided
-  :tag => UUID_STRING      # :tag will create scheduled maintenance periods for all checks that this tag is associated with
+  :check => CHECK_ID,      # one (and only one) of :check or :tag must be provided
+  :tag => TAG_NAME         # :tag will create scheduled maintenance periods for all checks that this tag is associated with
 }
 ```
 
@@ -566,8 +564,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all scheduled maintenance periods.
 
 ```ruby
-scheduled_maintenance = Flapjack::Diner.scheduled_maintenances(UUID_STRING)
-some_scheduled_maintenances = Flapjack::Diner.scheduled_maintenances(UUID_STRING, UUID_STRING, ...)
+scheduled_maintenance = Flapjack::Diner.scheduled_maintenances(SCHEDULED_MAINTENANCE_ID)
+some_scheduled_maintenances = Flapjack::Diner.scheduled_maintenances(SCHEDULED_MAINTENANCE_ID, SCHEDULED_MAINTENANCE_ID, ...)
 first_page_of_scheduled_maintenances = Flapjack::Diner.scheduled_maintenances
 ```
 
@@ -580,10 +578,10 @@ Update data for one or more scheduled maintenance periods.
 
 ```ruby
 # update values for one scheduled maintenance period
-Flapjack::Diner.update_scheduled_maintenances(:id => UUID_STRING, KEY => VALUE, ...)
+Flapjack::Diner.update_scheduled_maintenances(:id => SCHEDULED_MAINTENANCE_ID, KEY => VALUE, ...)
 
 # update values for multiple scheduled maintenance periods
-Flapjack::Diner.update_scheduled_maintenances({:id => UUID_STRING, KEY => VALUE, ...}, {:id => UUID_STRING, KEY => VALUE, ...})
+Flapjack::Diner.update_scheduled_maintenances({:id => SCHEDULED_MAINTENANCE_ID, KEY => VALUE, ...}, {:id => SCHEDULED_MAINTENANCE_ID, KEY => VALUE, ...})
 ```
 
 Acceptable update field keys are
@@ -602,8 +600,8 @@ Returns true if updating succeeded or false if updating failed.
 Delete one or more scheduled maintenance periods.
 
 ```ruby
-Flapjack::Diner.delete_scheduled_maintenances(UUID_STRING)
-Flapjack::Diner.delete_scheduled_maintenances(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_scheduled_maintenances(SCHEDULED_MAINTENANCE_ID)
+Flapjack::Diner.delete_scheduled_maintenances(SCHEDULED_MAINTENANCE_ID, SCHEDULED_MAINTENANCE_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -618,8 +616,8 @@ Returns true if deletion succeeded or false if deletion failed.
 Return data for one, some or all unscheduled maintenance periods.
 
 ```ruby
-unscheduled_maintenance = Flapjack::Diner.unscheduled_maintenances(UUID_STRING)
-some_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenances(UUID_STRING, UUID_STRING, ...)
+unscheduled_maintenance = Flapjack::Diner.unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID)
+some_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID, UNSCHEDULED_MAINTENANCE_ID, ...)
 first_page_of_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenances
 ```
 
@@ -631,10 +629,10 @@ first_page_of_unscheduled_maintenances = Flapjack::Diner.unscheduled_maintenance
 Update data for one or more unscheduled maintenance periods.
 
 ```ruby
-Flapjack::Diner.update_unscheduled_maintenances(:id => UUID_STRING, KEY => VALUE)
+Flapjack::Diner.update_unscheduled_maintenances(:id => UNSCHEDULED_MAINTENANCE_ID, KEY => VALUE)
 
-Flapjack::Diner.update_unscheduled_maintenances({:id => UUID_STRING, KEY => VALUE},
-  {:id => UUID_STRING, KEY => VALUE}, ...)
+Flapjack::Diner.update_unscheduled_maintenances({:id => UNSCHEDULED_MAINTENANCE_ID, KEY => VALUE},
+  {:id => UNSCHEDULED_MAINTENANCE_ID, KEY => VALUE}, ...)
 ```
 
 Acceptable update field keys are
@@ -653,8 +651,8 @@ Returns true if updating succeeded or false if updating failed.
 Delete one or more unscheduled maintenance periods.
 
 ```ruby
-Flapjack::Diner.delete_unscheduled_maintenances(UUID_STRING)
-Flapjack::Diner.delete_unscheduled_maintenances(UUID_STRING, UUID_STRING, ...)
+Flapjack::Diner.delete_unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID)
+Flapjack::Diner.delete_unscheduled_maintenances(UNSCHEDULED_MAINTENANCE_ID, UNSCHEDULED_MAINTENANCE_ID, ...)
 ```
 
 Returns true if deletion succeeded or false if deletion failed.
@@ -682,8 +680,8 @@ Flapjack::Diner.create_acknowledgements(ACKNOWLEDGEMENT, ...)
 {
   :summary => STRING,
   :duration => INTEGER,
-  :check => UUID_STRING,   # one (and only one) of :check or :tag must be provided
-  :tag => UUID_STRING      # :tag will acknowledge all failing checks that this tag is associated with
+  :check => CHECK_ID,   # one (and only one) of :check or :tag must be provided
+  :tag => TAG_NAME      # :tag will acknowledge all failing checks that this tag is associated with
 }
 ```
 
@@ -704,9 +702,8 @@ Flapjack::Diner.create_test_notifications(TEST_NOTIFICATION, ...)
 # TEST_NOTIFICATION
 {
   :summary => STRING,
-  :condition => STRING,
-  :check => UUID_STRING, # one (and only one) of :check or :tag must be provided
-  :tag => UUID_STRING    # :tag will send test notifications for all checks that this tag is associated with
+  :check => CHECK_ID, # one (and only one) of :check or :tag must be provided
+  :tag => TAG_NAME    # :tag will send test notifications for all checks that this tag is associated with
 }
 ```
 
@@ -725,8 +722,8 @@ Returns false if creation failed, or the created object(s) if it succeeded.
 Return data for one, some or all check states.
 
 ```ruby
-states = Flapjack::Diner.states(UUID_STRING)
-some_states = Flapjack::Diner.states(UUID_STRING, UUID_STRING, ...)
+states = Flapjack::Diner.states(STATE_ID)
+some_states = Flapjack::Diner.states(STATE_ID, STATE_ID, ...)
 first_page_of_states = Flapjack::Diner.states
 ```
 
@@ -749,8 +746,8 @@ metrics = Flapjack::Diner.metrics
 Return data for one, some or all flapjack processor instances.
 
 ```ruby
-statistics = Flapjack::Diner.statistics(UUID_STRING)
-some_statistics = Flapjack::Diner.statistics(UUID_STRING, UUID_STRING, ...)
+statistics = Flapjack::Diner.statistics(STATISTICS_ID)
+some_statistics = Flapjack::Diner.statistics(STATISTICS_ID, STATISTICS_ID, ...)
 first_page_of_statistics = Flapjack::Diner.statistics
 ```
 
@@ -774,31 +771,29 @@ first_page_of_statistics = Flapjack::Diner.statistics
 <a name="common_options_get_include">&nbsp;</a>
 ### Associated data allowed for the include parameter
 
-| Method                      |  Association                      | Assoc. Type                    |
-|-----------------------------|-----------------------------------|--------------------------------|
-| `.checks`                   | 'alerting_media'                  | ['medium', ...]                |
-| `.checks`                   | 'contacts'                        | ['contact', ...]               |
-| `.checks`                   | 'current_scheduled_maintenances'  | ['scheduled_maintenance', ...] |
-| `.checks`                   | 'current_state'                   | 'state'                        |
-| `.checks`                   | 'current_unscheduled_maintenance' | 'unscheduled_maintenance'      |
-| `.checks`                   | 'latest_notifications'            | ['state', ...]                 |
-| `.checks`                   | 'tags'                            | ['tag', ...]                   |
-| `.contacts`                 | 'checks'                          | ['check', ...]                 |
-| `.contacts`                 | 'media'                           | ['medium', ...]                |
-| `.contacts`                 | 'rules'                           | ['rule', ...]                  |
-| `.contacts`                 | 'tags'                            | ['tag', ...]                   |
-| `.media`                    | 'alerting_checks'                 | ['check', ...]                 |
-| `.media`                    | 'contact'                         | 'contact'                      |
-| `.media`                    | 'rules'                           | ['rule', ...]                  |
-| `.rules`                    | 'contact'                         | 'contact'                      |
-| `.rules`                    | 'media'                           | ['medium', ...]                |
-| `.rules`                    | 'tags'                            | ['tag', ...]                   |
-| `.scheduled_maintenances`   | 'check'                           | 'check'                        |
-| `.states`                   | 'check'                           | 'check'                        |
-| `.tags`                     | 'checks'                          | ['check', ...]                 |
-| `.tags`                     | 'contacts'                        | ['contact', ...]               |
-| `.tags`                     | 'rules'                           | ['rule', ...]                  |
-| `.unscheduled_maintenances` | 'check'                           | 'check'                        |
+| Method    |  Association | Assoc. Type |
+|-----------|--------------|-------------|
+| `.checks` | 'alerting_media'    | ['medium', ...] |
+| `.checks` | 'contacts'    | ['contact', ...] |
+| `.checks` | 'current_scheduled_maintenances'    | ['scheduled_maintenance', ...] |
+| `.checks` | 'current_state'    | 'state' |
+| `.checks` | 'current_unscheduled_maintenance'    | 'unscheduled_maintenance' |
+| `.checks` | 'latest_notifications'    | ['state', ...] |
+| `.checks` | 'tags'    | ['tag', ...] |
+| `.contacts` | 'checks' | ['check', ...] |
+| `.contacts` | 'media' | ['medium', ...] |
+| `.contacts` | 'rules' | ['rule', ...] |
+| `.media` | 'alerting_checks' | ['check', ...] |
+| `.media` | 'contact' | 'contact' |
+| `.media` | 'rules' | ['rule', ...] |
+| `.rules` | 'contact' | 'contact' |
+| `.rules` | 'media' | ['medium', ...] |
+| `.rules` | 'tags'    | ['tag', ...] |
+| `.scheduled_maintenances` | 'check' | 'check' |
+| `.states` | 'check' | 'check' |
+| `.tags` | 'checks' | ['check', ...] |
+| `.tags` | 'rules' | ['rule', ...] |
+| `.unscheduled_maintenances` | 'check' | 'check' |
 
 NB: these may be chained, as long as they follow the allowed paths above; e.g.
 
@@ -842,7 +837,6 @@ check_link_unscheduled_maintenances(check_id, opts = {})
 contact_link_checks(contact_id, opts = {})
 contact_link_media(contact_id, opts = {})
 contact_link_rules(contact_id, opts = {})
-contact_link_tags(contact_id, opts = {})
 
 medium_link_alerting_checks(medium_id, opts = {})
 medium_link_contact(medium_id, opts = {})
@@ -854,12 +848,8 @@ rule_link_tags(rule_id, opts = {})
 
 state_link_check(state_id, opts = {})
 
-tag_link_checks(tag_id, opts = {})
-tag_link_contacts(tag_id, opts = {})
-tag_link_rules(tag_id, opts = {})
-tag_link_scheduled_maintenances(tag_id, opts = {})
-tag_link_states(tag_id, opts = {})
-tag_link_unscheduled_maintenances(tag_id, opts = {})
+tag_link_checks(tag_name, opts = {})
+tag_link_rules(tag_name, opts = {})
 ```
 
 All returned results are paginated, and the [common options for GET requests](#common_options_get) apply here too.
@@ -867,16 +857,12 @@ All returned results are paginated, and the [common options for GET requests](#c
 <a name="object_relationships_write">&nbsp;</a>
 ### Manipulating object relationships
 
-The following operations are supported; please note that some associations (e.g. associating an rule with a contact) must be made on object creation, via the secondary resource's create method, and cannot be altered later.
+The following operations are supported; please note that some associations (e.g. associating a rule with a contact) must be made on object creation, via the secondary resource's create method, and cannot be altered later.
 
 ```
-create_check_link_tags(check_id, *tags_ids)
-update_check_link_tags(check_id, *tags_ids)
-delete_check_link_tags(check_id, *tags_ids)
-
-create_contact_link_tags(contact_id, *tags_ids)
-update_contact_link_tags(contact_id, *tags_ids)
-delete_contact_link_tags(contact_id, *tags_ids)
+create_check_link_tags(check_id, *tags_names)
+update_check_link_tags(check_id, *tags_names)
+delete_check_link_tags(check_id, *tags_names)
 
 create_medium_link_rules(medium_id, *rules_ids)
 update_medium_link_rules(medium_id, *rules_ids)
@@ -886,21 +872,17 @@ create_rule_link_media(rule_id, *media_ids)
 update_rule_link_media(rule_id, *media_ids)
 delete_rule_link_media(rule_id, *media_ids)
 
-create_rule_link_tags(rule_id, *tags_ids)
-update_rule_link_tags(rule_id, *tags_ids)
-delete_rule_link_tags(rule_id, *tags_ids)
-
-create_tag_link_checks(tag_id, *checks_ids)
-update_tag_link_checks(tag_id, *checks_ids)
-delete_tag_link_checks(tag_id, *checks_ids)
+create_rule_link_tags(rule_id, *tags_names)
+update_rule_link_tags(rule_id, *tags_names)
+delete_rule_link_tags(rule_id, *tags_names)
 
-create_tag_link_contacts(tag_id, *contacts_ids)
-update_tag_link_contacts(tag_id, *contacts_ids)
-delete_tag_link_contacts(tag_id, *contacts_ids)
+create_tag_link_checks(tag_name, *checks_ids)
+update_tag_link_checks(tag_name, *checks_ids)
+delete_tag_link_checks(tag_name, *checks_ids)
 
-create_tag_link_rules(tag_id, *rules_ids)
-update_tag_link_rules(tag_id, *rules_ids)
-delete_tag_link_rules(tag_id, *rules_ids)
+create_tag_link_rules(tag_name, *rules_ids)
+update_tag_link_rules(tag_name, *rules_ids)
+delete_tag_link_rules(tag_name, *rules_ids)
 ```
 
 <a name="object_relationships_write_create">&nbsp;</a>