documentation-zero 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4882b26240b6143fc91284a6b50e230a21fb3367ff223fbbf74b85b582622e67
-  data.tar.gz: c52ebd9ece21e06dd2397e6879ae07661d491198b8ef2a88169d929effb9b484
+  metadata.gz: 96f1e943d71e91ceb6caa7cba651a86e3f93e70c5ac1d2e27bd0498fd9d2a853
+  data.tar.gz: fff3f3e4acf8c71edff06491824431a1c71ccb660355aea8b79eb39c3a824f58
 SHA512:
-  metadata.gz: 1807652142ed5011dd35be639788c2bc651c35f08051d1f95a602deb68f59ff17fd49d87082fcc5189e7381669d4b18e6e26345ecb1b07696418d830992c3260
-  data.tar.gz: c42fc5525c9057585ee27103bb58a42650507835c5531c77589e00affdc1efc6ce0237d9ff8d3fcbad7c9579b1ac30bc607d84c468731e8814678023b6cf4dfb
+  metadata.gz: 96e451239ab9a7ae56c792d0901a1c22128983273dc1a827a2f26b236b573a10e38565ebec7a7510161b1b1e108f7e99b8c9cedf22bb59995422a88febd721bd
+  data.tar.gz: 4778a6f4796e2d59f244a2af8982b3512136276c7d4b829990fc13d74e5b89f08631a2f35f97247324a4c0d7c0297cb954943f259d6910611956db83068c4939

data/.documentation_api/sections/posts.md

@@ -19,8 +19,8 @@ Models:
 <!--
 _Optional query parameters_:
 
-* `attribute1` - when set to true, will only return resources that are completed.
-* `attribute2` - when set to true, will only return resources that are completed.
+* `attribute1` - when set to true, will only return resources that...
+* `attribute2` - when set to true, will only return resources that...
 -->
 
 See the [Post model](#post-model) for more info on the response payload.
@@ -36,15 +36,20 @@ See the [Post model](#post-model) for more info on the response payload.
 - `POST /posts.json` creates post.
 
 <!--
-**Required parameters**: `attribute1` and `attribute2`.
+**Required parameters**:
+
+* `title` - title of the post.
+* `content` - content of the post.
+* `published` - published of the post.
+* `user_id` - user of the post.
 -->
 
 _Optional parameters_:
 
-* `title` - attribute from post.
-* `content` - attribute from post.
-* `published` - attribute from post.
-* `user_id` - attribute from post.
+* `title` - title of the post.
+* `content` - content of the post.
+* `published` - published of the post.
+* `user_id` - user of the post.
 
 This endpoint will return `201 Created` with the current JSON representation of the post if the creation was a success. See the [Post model](#post-model) for more info on the payload.
 
@@ -52,18 +57,9 @@ This endpoint will return `201 Created` with the current JSON representation of
 
 - `PUT /posts/1.json` allows changing the post with an ID of `1`.
 
-This endpoint will return `200 OK` with the current JSON representation of the post if the update was a success. See the [Post model](#post-model) for more info on the payload.
-
-<!--
-**Required parameters**: `attribute1` and `attribute2`.
--->
-
-_Optional parameters_:
+You may change any of the required or optional parameters as listed in the [create post](#create-post) endpoint.
 
-* `title` - attribute from post.
-* `content` - attribute from post.
-* `published` - attribute from post.
-* `user_id` - attribute from post.
+This endpoint will return `200 OK` with the current JSON representation of the post if the update was a success. See the [Post model](#post-model) for more info on the payload.
 
 ## Delete post
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    documentation-zero (0.0.6)
+    documentation-zero (0.0.7)
 
 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](.documentation_api/README.md).
 
 ## Installation
 

data/lib/documentation_zero/version.rb

@@ -1,3 +1,3 @@
 module DocumentationZero
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

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

@@ -19,8 +19,8 @@ Models:
 <!--
 _Optional query parameters_:
 
-* `attribute1` - when set to true, will only return resources that are completed.
-* `attribute2` - when set to true, will only return resources that are completed.
+* `attribute1` - when set to true, will only return resources that...
+* `attribute2` - when set to true, will only return resources that...
 -->
 
 See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more info on the response payload.
@@ -36,13 +36,17 @@ See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more in
 - `POST /<%= plural_name %>.json` creates <%= human_name.downcase %>.
 
 <!--
-**Required parameters**: `attribute1` and `attribute2`.
+**Required parameters**:
+
+<% attributes.each do |attribute| -%>
+* `<%= attribute.column_name %>` - <%= attribute.name.humanize(capitalize: false) %> of the <%= human_name.downcase %>.
+<% end -%>
 -->
 
 _Optional parameters_:
 
 <% attributes.each do |attribute| -%>
-* `<%= attribute.column_name %>` - attribute from <%= human_name.downcase %>.
+* `<%= attribute.column_name %>` - <%= attribute.name.humanize(capitalize: false) %> of the <%= human_name.downcase %>.
 <% end -%>
 
 This endpoint will return `201 Created` with the current JSON representation of the <%= human_name.downcase %> if the creation was a success. See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more info on the payload.
@@ -51,17 +55,9 @@ This endpoint will return `201 Created` with the current JSON representation of
 
 - `PUT /<%= plural_name %>/1.json` allows changing the <%= human_name.downcase %> with an ID of `1`.
 
-This endpoint will return `200 OK` with the current JSON representation of the <%= human_name.downcase %> if the update was a success. See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more info on the payload.
+You may change any of the required or optional parameters as listed in the [create <%= human_name.downcase %>](#create-<%= singular_name.dasherize %>) endpoint.
 
-<!--
-**Required parameters**: `attribute1` and `attribute2`.
--->
-
-_Optional parameters_:
-
-<% attributes_names.each do |attribute| -%>
-* `<%= attribute %>` - attribute from <%= human_name.downcase %>.
-<% end -%>
+This endpoint will return `200 OK` with the current JSON representation of the <%= human_name.downcase %> if the update was a success. See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more info on the payload.
 
 ## Delete <%= human_name.downcase %>
 

metadata

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