documentation-zero 0.0.10 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c886deb2e5f957a2f6683c8766d75b9ee0b6c3e6b9e85a7a221c3a18ea2f1ef7
-  data.tar.gz: ee3f4edb0b2dadc8e7593ef8f19c5b226cef019488cd27b481957929a0cca290
+  metadata.gz: b4746ff3f223a95242e7fd9c5822a30f4227d3e328b957e06e609ff9843a81e2
+  data.tar.gz: 4b4704d8cd4905d4c76daa28f7b1902feae78bb9d1df6a5a97f4898b5f06a814
 SHA512:
-  metadata.gz: c467fd091ff67eafcc270466afc4ed79f86622a2d2cee4814c3ff0e4220a3c9bf27bb2c2e9565be74f0cc4c6ca1da3488d1b36ffadb997145ce3aa0824ba1f67
-  data.tar.gz: 12e7fe2eb9d5efa5f1d16d285c8d4c7894c67158168f5cf89ab4d3ccf72ec0cad502002f1a8980fcf28e36e4024a36f1aadf9718a88602d3c6e86e47f40689c8
+  metadata.gz: 3dfe383d00f94cfa094112fc505695fe79d969df90adbeabc0019446e6e55dd43d18b4f73d137de016a2a76f3893f5b7ccfae547928eb40480169835bf153bd0
+  data.tar.gz: 70d79a64c92186376aa494fa86232e1d59eb7b762cf2e1cac5ced854636774b166c831701ff6ce8e2e37100bd6adb1e5971243ad31032e2982834ed0da09c777

data/{.documentation_api → .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/{.documentation_api → .api}/sections/posts.md

@@ -67,14 +67,13 @@ This endpoint will return `200 OK` with the current JSON representation of the p
 
 This endpoint will return `204 No Content` if successful. No parameters are required.
 
----
-
 ## Models
 
-###### Post model
+### Post model
 
 ```json
 {
+  "id": "integer",
   "title": "string",
   "content": "string",
   "published": "boolean",

data/Gemfile.lock

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

data/README.md

@@ -4,7 +4,7 @@ The purpose of documentation zero is to generate a scaffold for rails api docume
 
 ## Example
 
-You can see an example of the generated documentation [here](.documentation_api/README.md).
+You can see an example of the generated documentation [here](.api/README.md).
 
 ## Installation
 

data/lib/documentation_zero/version.rb

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

data/lib/generators/documentation/readme/readme_generator.rb

@@ -3,8 +3,10 @@ module Documentation
     class ReadmeGenerator < Rails::Generators::Base
       source_root File.expand_path("templates", __dir__)
 
+      class_option :directory, type: :string, default: ".api"
+
       def copy_files
-        template "README.md", ".documentation_api/README.md"
+        template "README.md", "#{options.directory}/README.md"
       end
 
       private

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 -->

data/lib/generators/documentation/scaffold/scaffold_generator.rb

@@ -3,12 +3,13 @@ module Documentation
     class ScaffoldGenerator < Rails::Generators::NamedBase
       argument :attributes, type: :array, default: [], banner: "field:type field:type"
 
+      class_option :directory,  type: :string,  default: ".api"
       class_option :timestamps, type: :boolean, default: true
 
       source_root File.expand_path("templates", __dir__)
 
       def copy_files
-        template "resource.md", ".documentation_api/sections/#{plural_file_name}.md"
+        template "resource.md", "#{options.directory}/sections/#{plural_file_name}.md"
       end
     end
   end

data/lib/generators/documentation/scaffold/templates/resource.md.tt

@@ -65,14 +65,13 @@ This endpoint will return `200 OK` with the current JSON representation of the <
 
 This endpoint will return `204 No Content` if successful. No parameters are required.
 
----
-
 ## Models
 
-###### <%= class_name %> model
+### <%= class_name %> model
 
 ```json
 {
+  "id": "integer",
 <% attributes.each do |attribute| -%>
 <% if attribute.password_digest? -%>
   "password_digest": "string",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.13
 platform: ruby
 authors:
 - Nixon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 2022-04-09 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -17,8 +17,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".documentation_api/README.md"
-- ".documentation_api/sections/posts.md"
+- ".api/README.md"
+- ".api/sections/posts.md"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile