documentation-zero 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2989992b190b783b8c1b3ce258176d949e229ce32bb7e045aa0257df0a084abd
-  data.tar.gz: 828dd73c95fe502c16e0b871e75c197cff726cb5de25da3c0c5a669d7b4b2210
+  metadata.gz: 4882b26240b6143fc91284a6b50e230a21fb3367ff223fbbf74b85b582622e67
+  data.tar.gz: c52ebd9ece21e06dd2397e6879ae07661d491198b8ef2a88169d929effb9b484
 SHA512:
-  metadata.gz: fa4e0d3497944a64a5a65f5a1a084d4db098c4ee299c6d5dce05dc134a0994c910aeb2a32cc9538e851d8f499ae7799753d62676c6eff42523cc19a32f7fc69c
-  data.tar.gz: eb239336346a5209254083744c3c1ea257da446d3be6e78bbd5071a35be4fbe4d0c872e9ac248b2406ea664d5269b4562a84088bd97ea16e7bb60cd2ccf97215
+  metadata.gz: 1807652142ed5011dd35be639788c2bc651c35f08051d1f95a602deb68f59ff17fd49d87082fcc5189e7381669d4b18e6e26345ecb1b07696418d830992c3260
+  data.tar.gz: c42fc5525c9057585ee27103bb58a42650507835c5531c77589e00affdc1efc6ce0237d9ff8d3fcbad7c9579b1ac30bc607d84c468731e8814678023b6cf4dfb

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.
@@ -19,13 +23,13 @@ _Optional query parameters_:
 * `attribute2` - when set to true, will only return resources that are completed.
 -->
 
-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
 
@@ -40,14 +44,15 @@ _Optional parameters_:
 * `title` - attribute from post.
 * `content` - attribute from post.
 * `published` - attribute from post.
+* `user_id` - attribute from 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.
+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`.
@@ -58,6 +63,7 @@ _Optional parameters_:
 * `title` - attribute from post.
 * `content` - attribute from post.
 * `published` - attribute from post.
+* `user_id` - attribute from post.
 
 ## Delete post
 
@@ -67,12 +73,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": "users.md#user-model",
 }
 ```

data/Gemfile.lock

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

data/README.md

@@ -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.6"
 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 %>.
@@ -19,13 +23,13 @@ _Optional query parameters_:
 * `attribute2` - when set to true, will only return resources that are completed.
 -->
 
-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 %>
 
@@ -41,13 +45,13 @@ _Optional parameters_:
 * `<%= attribute.column_name %>` - attribute from <%= 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.
+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.
 
 <!--
 **Required parameters**: `attribute1` and `attribute2`.
@@ -67,19 +71,21 @@ 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 %>
+  "<%= attribute.name %>": "string",
 <% elsif attribute.reference? -%>
-  integer <%= attribute.column_name %>
+  "<%= attribute.name %>": "<%= attribute.name.pluralize %>.md#<%= attribute.name.dasherize %>-model",
 <% 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.6
 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: