documentation-zero 0.0.4 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2650852c4529a8d663213c01b7c0b492fd81c601247c817ce17cf204a5f44872
-  data.tar.gz: b2eee6d289c54bf1ef547b0e8cf4f52df36bfd6b164ca96523b095daa37e35c4
+  metadata.gz: 96f1e943d71e91ceb6caa7cba651a86e3f93e70c5ac1d2e27bd0498fd9d2a853
+  data.tar.gz: fff3f3e4acf8c71edff06491824431a1c71ccb660355aea8b79eb39c3a824f58
 SHA512:
-  metadata.gz: b8d1ef81d109b58cab60dd37b06eb9ba310a7fcfc8c59efcd7de8bc14fb907e90820dfeb6aefb62c4dea09326b367ec9f41d70dfab991b69e56608e2e3eb695d
-  data.tar.gz: a8de4dc6df6b59904c9b649fd27f9d443e98e6765234d1348fc55295718522ec638370f8f3b1dc34ffc41111747f99bb615a888d4031a43b6962ea74d013b356
+  metadata.gz: 96e451239ab9a7ae56c792d0901a1c22128983273dc1a827a2f26b236b573a10e38565ebec7a7510161b1b1e108f7e99b8c9cedf22bb59995422a88febd721bd
+  data.tar.gz: 4778a6f4796e2d59f244a2af8982b3512136276c7d4b829990fc13d74e5b89f08631a2f35f97247324a4c0d7c0297cb954943f259d6910611956db83068c4939

data/.documentation_api/sections/posts.md

@@ -8,6 +8,10 @@ Endpoints:
 - [Update post](#update-post)
 - [Delete post](#delete-post)
 
+Models:
+
+- [Post model](#post-model)
+
 ## Get posts
 
 - `GET /posts.json` will return a [paginated list](../README.md#pagination) of posts.
@@ -15,49 +19,47 @@ Endpoints:
 <!--
 _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) model for more info on the response payload.
+See the [Post model](#post-model) for more info on the response payload.
 
 ## Get post
 
 - `GET /posts/1.json` will return the post with an ID of `1`.
 
-See the [post](#model) model for more info on the response payload.
+See the [Post model](#post-model) for more info on the response payload.
 
 ## Create post
 
 - `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.
+* `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) model for more info on the payload.
+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.
 
 ## Update post
 
 - `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) 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.
+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
 
@@ -67,11 +69,15 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
 
 ---
 
-## Model
+## Models
+
+###### Post model
+
 ```json
 {
   "title": "string",
   "content": "string",
   "published": "boolean",
+  "user": "users.md#user-model",
 }
 ```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    documentation-zero (0.0.4)
+    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
 
@@ -21,7 +21,7 @@ rails generate documentation:readme
 ```
 
 ```
-rails generate documentation:scaffold posts title:string body:text published:boolean
+rails generate documentation:scaffold posts title:string body:text published:boolean user:references
 ```
 
 Add ```- [Posts](sections/posts.md)``` to API endpoints section.

data/lib/documentation_zero/version.rb

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

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

@@ -8,6 +8,10 @@ Endpoints:
 - [Update <%= human_name.downcase %>](#update-<%= singular_name.dasherize %>)
 - [Delete <%= human_name.downcase %>](#delete-<%= singular_name.dasherize %>)
 
+Models:
+
+- [<%= class_name %> model](#<%= singular_name.dasherize %>-model)
+
 ## Get <%= human_name.pluralize.downcase %>
 
 - `GET /<%= plural_name %>.json` will return a [paginated list](../README.md#pagination) of <%= human_name.pluralize.downcase %>.
@@ -15,49 +19,45 @@ Endpoints:
 <!--
 _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 [<%= human_name.downcase %>](#model) model for more info on the response payload.
+See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more info on the response payload.
 
 ## Get <%= human_name.downcase %>
 
 - `GET /<%= plural_name %>/1.json` will return the <%= human_name.downcase %> with an ID of `1`.
 
-See the [<%= human_name.downcase %>](#model) model for more info on the response payload.
+See the [<%= class_name %> model](#<%= class_name.downcase %>-model) for more info on the response payload.
 
 ## Create <%= human_name.downcase %>
 
 - `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 [<%= human_name.downcase %>](#model) model for more info on the payload.
+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.
 
 ## Update <%= human_name.downcase %>
 
 - `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 [<%= human_name.downcase %>](#model) 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 %>
 
@@ -67,18 +67,21 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
 
 ---
 
-## Model
+## Models
+
+###### <%= class_name %> model
+
 ```json
 {
 <% attributes.each do |attribute| -%>
 <% if attribute.password_digest? -%>
   "password_digest": "string",
 <% elsif attribute.token? -%>
-  "<%= attribute.column_name %>": "string",
+  "<%= attribute.name %>": "string",
 <% elsif attribute.reference? -%>
-  "<%= attribute.column_name %>": "integer",
+  "<%= attribute.name %>": "<%= attribute.name.pluralize %>.md#<%= attribute.name.dasherize %>-model",
 <% elsif !attribute.virtual? -%>
-  "<%= attribute.column_name %>": "<%= attribute.type %>",
+  "<%= attribute.name %>": "<%= attribute.type %>",
 <% end -%>
 <% end -%>
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: documentation-zero
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.7
 platform: ruby
 authors:
 - Nixon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-18 00:00:00.000000000 Z
+date: 2022-03-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email: