rails_api_documentation 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdf183cc6b6c0fda395a7562bc1d114b87bb1478
-  data.tar.gz: 6dd2a3f83b5cac67029bc216d87ab76d14db884b
+  metadata.gz: 7536a83956fb84f99bafaaedd7b342bb31e55452
+  data.tar.gz: 4cfb6323f7122a800f0bc20672fddd4038819141
 SHA512:
-  metadata.gz: 1394d326673eab65074575a2de2ea16801c8c8f406302f06e7197e325131a5271b38636ca5ba3afc0816a7a56f1980d0ae52287593cef52218a44207310a11fd
-  data.tar.gz: 2a8b66d882789e7d4fd81aa40b8bed53dda409c67a375d00dc0bc6cd86401cd4df5c339bb7aa505b789b64fdf7a4b01b86b6f859d7eb517d50ac8090e3dbf01c
+  metadata.gz: 99461d810397dea52c9f97712a0d616461bc299d45ebbc72fbfc09cbf260f9be69d12a021dff392adc6164eb9a0e70f4f2d12c5c3eb16a31047106cbf033c5af
+  data.tar.gz: cb592b3ef29c0c8c704e4795a02d481935c8f996062c4b4dbb2be51ddae9b043a54e7c9f3e4001a0dab9a06f101bc6bd9efeea1dcad470f0ea219c5f29caa4f1

data/README.md

@@ -1,8 +1,5 @@
-# RailsApiDoc
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rails_api_doc`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+# RailsApiDoc
 
 ## Installation
 
@@ -22,20 +19,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To display api documentation on route '/api_doc' you need to:
 
-## Development
+1. config/routes.rb ->
+  ```ruby
+    mount RailsApiDoc::Engine => '/api_doc'
+  ```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+2. define request parameters. Example:
+  ```ruby
+    class AuthorsController < ApplicationController
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+      has_scope :article_id, :name
 
-## Contributing
+      # Define parameters with type and nested options
+      parameter :age, type: Integer
+      parameter :name, type: String, required: true
+      parameter :articles, type: :model, model: Article do
+        parameter :title, type: String
+        parameter :body, type: String, required: true
+        parameter :rating, type: :enum, enum: [1, 2, 3]
+        parameter :data, type: :model, model: Datum do
+          parameter :creation_date, type: DateTime
+          parameter :comment, type: String
+        end
+      end
+      parameter :test, type: String, required: true
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_api_doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+    end
+  ```
 
+Parameter type may be one of these:
+
+  ```ruby
+    ACCEPTED_TYPES = [Bool, String, Integer, Object, Array, DateTime, :enum, :model].freeze
+  ```
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/rails_api_doc/controller/parameter/repository/param.rb

@@ -2,7 +2,7 @@
 # author: Vadim Shaveiko <@vshaveyko>
 class RailsApiDoc::Controller::Parameter::Repository::Param
 
-  ACCEPTED_TYPES = [String, Integer, Object, Array, DateTime, :enum, :model].freeze
+  ACCEPTED_TYPES = [Bool, String, Integer, Object, Array, DateTime, :enum, :model].freeze
 
   # @type - type to check
   def self.accepted_nested_type?(type)

data/lib/rails_api_doc/engine.rb

@@ -5,7 +5,6 @@ require 'action_view'
 require 'jquery-rails'
 require 'slim'
 
-require_relative 'types'
 require_relative 'controller'
 require_relative 'controller/strong_params'
 require_relative 'controller/attribute_parser'

data/lib/rails_api_doc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 module RailsApiDoc
-  VERSION = '0.1.6'
+  VERSION = '0.1.7'
 end

data/lib/rails_api_doc.rb

@@ -26,3 +26,7 @@ end
 
 require 'rails_api_doc/version'
 require 'rails_api_doc/engine'
+
+# constant for defining in controllers
+class Bool
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - vs
@@ -170,7 +170,6 @@ files:
 - lib/rails_api_doc/controller/response_factory.rb
 - lib/rails_api_doc/controller/strong_params.rb
 - lib/rails_api_doc/engine.rb
-- lib/rails_api_doc/types.rb
 - lib/rails_api_doc/version.rb
 homepage: https://github.com/vshaveyko/rails_api_doc
 licenses:

data/lib/rails_api_doc/types.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-# author: Vadim Shaveiko <@vshaveyko>
-class RailsApiDoc::Types
-
-  ACCEPTED_TYPES = [String, Integer, Object, Array, :enum].freeze
-
-end