From b41d1bb553a807fa245dd95dc2ba2df461ff0f70 Mon Sep 17 00:00:00 2001
From: Martin Levy <martin@cloudflare.com>
Date: Mon, 28 Nov 2016 12:51:07 -0800
Subject: [PATCH] Added documentation for error response

---
 README.md  | 33 ++++++++++++++++++++++++++++++++-
 README.rst | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 66 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e5b075c..4b534a8 100644
--- a/README.md
+++ b/README.md
@@ -291,7 +291,6 @@ This produces.
 
 A full example of paging is provided below.
 
-
 ### Exceptions
 
 The library will raise **CloudFlareAPIError** when the API call fails.
@@ -331,6 +330,38 @@ import CloudFlare.exceptions
     ...
 ```
 
+### Exception examples
+
+Here's examples using the CLI command cli4 of the responses passed back in exceptions.
+
+First a simple get with a clean (non-error) response.
+
+```
+$ cli4 /zones/:example.com/dns_records | jq -c '.[]|{"name":.name,"type":.type,"content":.content}'
+{"name":"example.com","type":"MX","content":"something.example.com"}
+{"name":"something.example.com","type":"A","content":"10.10.10.10"}
+$
+```
+
+Next a simple/single error response.
+This is simulated by providing incorrect authentication information.
+
+```
+$ CF_API_EMAIL='someone@example.com' cli4 /zones/
+cli4: /zones - 9103 Unknown X-Auth-Key or X-Auth-Email
+$
+```
+
+Finally, a command that provides more than one error response.
+This is simulated by passing an invalid IPv4 address to a DNS record creation.
+
+```
+$ cli4 --post name='foo' type=A content="1" /zones/:example.com/dns_records
+cli4: /zones/:mahtin.net/dns_records - 9005 Content for A record is invalid. Must be a valid IPv4 address
+cli4: /zones/:mahtin.net/dns_records - 1004 DNS Validation Error
+$
+```
+
 ## Included example code
 
 The [examples](https://github.com/cloudflare/python-cloudflare/tree/master/examples) folder contains many examples in both simple and verbose formats.
diff --git a/README.rst b/README.rst
index 21f8b4e..4e1b0a8 100644
--- a/README.rst
+++ b/README.rst
@@ -368,6 +368,40 @@ the additional error.
             exit('api error: %d %s' % (e, e))
         ...
 
+Exception examples
+~~~~~~~~~~~~~~~~~~
+
+Here's examples using the CLI command cli4 of the responses passed back
+in exceptions.
+
+First a simple get with a clean (non-error) response.
+
+::
+
+    $ cli4 /zones/:example.com/dns_records | jq -c '.[]|{"name":.name,"type":.type,"content":.content}'
+    {"name":"example.com","type":"MX","content":"something.example.com"}
+    {"name":"something.example.com","type":"A","content":"10.10.10.10"}
+    $
+
+Next a simple/single error response. This is simulated by providing
+incorrect authentication information.
+
+::
+
+    $ CF_API_EMAIL='someone@example.com' cli4 /zones/
+    cli4: /zones - 9103 Unknown X-Auth-Key or X-Auth-Email
+    $
+
+Finally, a command that provides more than one error response. This is
+simulated by passing an invalid IPv4 address to a DNS record creation.
+
+::
+
+    $ cli4 --post name='foo' type=A content="1" /zones/:example.com/dns_records
+    cli4: /zones/:mahtin.net/dns_records - 9005 Content for A record is invalid. Must be a valid IPv4 address
+    cli4: /zones/:mahtin.net/dns_records - 1004 DNS Validation Error
+    $
+
 Included example code
 ---------------------