jsonapi-swagger 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2451e820082b9b97f3ec0d6ba3fbf9d7f8bb17276a8b99ddd1901f60ccc7d214
-  data.tar.gz: aacdea086604b346aa42d022478b8e088bd38f97d91c5b861be7593469eb8f10
+  metadata.gz: 38a21f228ae6527871910d16622f39218d08f0c8310d44efd7b9472dd089e172
+  data.tar.gz: e44e41b8e18e7eda501da5b20bf15fc79c35f6fa351340d8fdb13e2d2d7907b5
 SHA512:
-  metadata.gz: 9dc72e490d688a7e84e87aed24f3c3071e0aea054eb3a4a5171532841f2f95cf715a278814767bf2ebe25be529a9cc2cff0c07ea38999215404badd750e44bfc
-  data.tar.gz: 512a1a4ec818091f046e22a4cf3d95a14c5d6081940d8be1dc12e148ff515da8ba6a5af08e34beb0c3b1946497aee3268e26ed80bbfea722860b9cb34b6640b4
+  metadata.gz: 3a780d9bb80023f3c2350edb259cc45219e4acbb912381539e4a1bcf7c91307e2f858bba8f3c5eab484a5bb890b36a497fe41333204efcbe44c2a111ce5e3288
+  data.tar.gz: 7262ffab5f06d2e7423d6bff37bb8ae4aac44053aab3d9c0eef4a912db4af71a86858d490651e175b791d0ed90f81c914b2a46d761669353af23b169c395f657

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 superiorlu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,8 @@
 # JSONAPI Swagger
 
-Create a JSONAPI Swagger.
+Generate JSONAPI Swagger Doc.
+
+[![Gem Version](https://img.shields.io/gem/v/jsonapi-swagger.svg)](https://rubygems.org/gems/jsonapi-swagger) [![GitHub license](https://img.shields.io/github/license/superiorlu/jsonapi-swagger.svg)](https://github.com/superiorlu/jsonapi-swagger/blob/master/LICENSE.md)
 
 ## Installation
 
@@ -24,6 +26,12 @@ Or install it yourself as:
 rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource
 ```
 
+## Resource
+
+- [JSONAPI](https://jsonapi.org/)
+- [JSONAPI::Resources](http://jsonapi-resources.com/)
+- [Rswag](https://github.com/domaindrivendev/rswag)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/superiorlu/jsonapi-swagger.

data/lib/generators/jsonapi/swagger/templates/swagger.rb.erb

@@ -13,8 +13,8 @@ RSpec.describe '<%= resouces_name %>', type: :request do
       parameter name: :'page[number]', in: :query, type: :string, description: '<%= t(:page_num) %>', required: false
       parameter name: :include, in: :query, type: :string, description: '<%= t(:include_related_data) %>', required: false
       parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
-<% relationships.each_key do |relation| -%>
-      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
+<% relationships.each_value do |relation| -%>
+      parameter name: :'fields[<%= relation.class_name.tableize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
       response '200', '<%= t(:get_list) %>' do
         schema type: :object,
@@ -98,8 +98,8 @@ RSpec.describe '<%= resouces_name %>', type: :request do
       parameter name: :id, in: :path, type: :integer, description: 'ID', required: true
       parameter name: :include, in: :query, type: :string, description: '<%= t(:include_related_data) %>', required: false
       parameter name: :'fields[<%= route_resouces %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
-<% relationships.each_key do |relation| -%>
-      parameter name: :'fields[<%= relation.to_s.pluralize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
+<% relationships.each_value do |relation| -%>
+      parameter name: :'fields[<%= relation.class_name.tableize %>]', in: :query, type: :string, description: '<%= t(:display_field) %>', required: false
 <% end -%>
       response '200', '<%= t(:get_detail) %>' do
         schema type: :object,

data/lib/jsonapi/swagger/version.rb

@@ -2,6 +2,6 @@
 
 module Jsonapi
   module Swagger
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-25 00:00:00.000000000 Z
+date: 2019-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.md
 - README.md
 - lib/generators/jsonapi/swagger/USAGE
 - lib/generators/jsonapi/swagger/swagger_generator.rb