documentation-zero 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c886deb2e5f957a2f6683c8766d75b9ee0b6c3e6b9e85a7a221c3a18ea2f1ef7
-  data.tar.gz: ee3f4edb0b2dadc8e7593ef8f19c5b226cef019488cd27b481957929a0cca290
+  metadata.gz: 97fbe4b0c16b2f7245a7b77979114e7256aca1a38dae972ce1b05a5988bcaec5
+  data.tar.gz: e950699801c5933f0ed88c7e06dd48a4a350a71cac814c47e4a0f17277d8dc72
 SHA512:
-  metadata.gz: c467fd091ff67eafcc270466afc4ed79f86622a2d2cee4814c3ff0e4220a3c9bf27bb2c2e9565be74f0cc4c6ca1da3488d1b36ffadb997145ce3aa0824ba1f67
-  data.tar.gz: 12e7fe2eb9d5efa5f1d16d285c8d4c7894c67158168f5cf89ab4d3ccf72ec0cad502002f1a8980fcf28e36e4024a36f1aadf9718a88602d3c6e86e47f40689c8
+  metadata.gz: 5641ab04a82885b693163a82e1442565cf374114b86e152e5e7b2b5839d358392d02ecaf2944390ad60d53bd3710cf171e67bce5b34b1a2361eb5b612dbb430f
+  data.tar.gz: f8405a25a46cbcab6f798a6fb4ccde933d7fda7cba89acce00a2846d5aa778a03e9ca4b0d5b7658fae51542e81ee1884e7a1a78f47586627149aed59666fa7e4

data/.documentation_api/README.md

@@ -12,6 +12,10 @@ To make a request for all the resources on your account, append the `resources`
 curl -H "Authorization: Bearer $ACCESS_TOKEN" -H 'User-Agent: MyApp (yourname@example.com)' https://example.com/api/resources.json
 ```
 
+## Authentication
+
+Describe your authentication here.
+
 ## Identifying your application
 
 You must include a `User-Agent` header with **both**:
@@ -64,6 +68,9 @@ If Rails tabler is having trouble, you will get a response with a 5xx status cod
 
 API requests may 404 due to deleted content, an inactive account, missing user permissions, etc. Detect these conditions to give your users a clear explanation about why they can't connect to Rails tabler. Do not automatically retry these requests.
 
+* Inactive account. 404 Not Found response with a `Reason: Account Inactive` header. Due to an expired trial or account suspension. All API requests to an inactive account will fail, so we recommend detecting and disabling the account in your integration as well.
+* Inaccessible items. 404 Not Found response. Due to a deleted item or insufficient permissions.
+
 ## API endpoints
 
 <!-- START API ENDPOINTS -->

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    documentation-zero (0.0.10)
+    documentation-zero (0.0.11)
 
 GEM
   remote: https://rubygems.org/

data/lib/documentation_zero/version.rb

@@ -1,3 +1,3 @@
 module DocumentationZero
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/generators/documentation/readme/templates/README.md.tt

@@ -12,6 +12,10 @@ To make a request for all the resources on your account, append the `resources`
 curl -H "Authorization: Bearer $ACCESS_TOKEN" -H 'User-Agent: MyApp (yourname@example.com)' https://example.com/api/resources.json
 ```
 
+## Authentication
+
+Describe your authentication here.
+
 ## Identifying your application
 
 You must include a `User-Agent` header with **both**:
@@ -64,6 +68,9 @@ If <%= application_name.humanize %> is having trouble, you will get a response w
 
 API requests may 404 due to deleted content, an inactive account, missing user permissions, etc. Detect these conditions to give your users a clear explanation about why they can't connect to <%= application_name.humanize %>. Do not automatically retry these requests.
 
+* Inactive account. 404 Not Found response with a `Reason: Account Inactive` header. Due to an expired trial or account suspension. All API requests to an inactive account will fail, so we recommend detecting and disabling the account in your integration as well.
+* Inaccessible items. 404 Not Found response. Due to a deleted item or insufficient permissions.
+
 ## API endpoints
 
 <!-- START API ENDPOINTS -->

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: documentation-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Nixon