documentation-zero 0.0.5 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2989992b190b783b8c1b3ce258176d949e229ce32bb7e045aa0257df0a084abd
-  data.tar.gz: 828dd73c95fe502c16e0b871e75c197cff726cb5de25da3c0c5a669d7b4b2210
+  metadata.gz: ff0cfd8d7c31a648ac6ffb886529c5dbc3b52ec4b23cb5edff680332d6196823
+  data.tar.gz: 3e2452da26d4e5cdc39a86e94a0ce654becfc4e1e518512c16401caf57c737d2
 SHA512:
-  metadata.gz: fa4e0d3497944a64a5a65f5a1a084d4db098c4ee299c6d5dce05dc134a0994c910aeb2a32cc9538e851d8f499ae7799753d62676c6eff42523cc19a32f7fc69c
-  data.tar.gz: eb239336346a5209254083744c3c1ea257da446d3be6e78bbd5071a35be4fbe4d0c872e9ac248b2406ea664d5269b4562a84088bd97ea16e7bb60cd2ccf97215
+  metadata.gz: 9dda90a920a2e861c89419c0a8805eded8016f7f2944d7d5e276b6e60dcb3bd52f041aa7a7b5002a3adbb0e62a2711ad60abfd02d8cc9f4c1290800675b523fc
+  data.tar.gz: 3e3c0f3b5a7608f19d4606ef1d52b51518b82871891bb616716f4f68409c03c2f35c73fcf9246f0e27b402fd73c4ad7accfa6a31b095795f28f938d2a1780010

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,12 +69,15 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
 
 ---
 
-## Model
-```mermaid
-classDiagram
-class Post {
-  string title
-  string content
-  boolean published
+## Models
+
+###### Post model
+
+```json
+{
+  "title": "string",
+  "content": "string",
+  "published": "boolean",
+  "user": "references",
 }
 ```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    documentation-zero (0.0.5)
+    documentation-zero (0.0.8)
 
 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.5"
+  VERSION = "0.0.8"
 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,19 +67,19 @@ This endpoint will return `204 No Content` if successful. No parameters are requ
 
 ---
 
-## Model
-```mermaid
-classDiagram
-class <%= class_name %> {
+## Models
+
+###### <%= class_name %> model
+
+```json
+{
 <% attributes.each do |attribute| -%>
 <% if attribute.password_digest? -%>
-  string password_digest
+  "password_digest": "string",
 <% elsif attribute.token? -%>
-  string <%= attribute.column_name %>
-<% elsif attribute.reference? -%>
-  integer <%= attribute.column_name %>
+  "<%= attribute.name %>": "string",
 <% elsif !attribute.virtual? -%>
-  <%= attribute.type %> <%= attribute.column_name %>
+  "<%= 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.5
+  version: 0.0.8
 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: