jsonapi-swagger 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38a21f228ae6527871910d16622f39218d08f0c8310d44efd7b9472dd089e172
-  data.tar.gz: e44e41b8e18e7eda501da5b20bf15fc79c35f6fa351340d8fdb13e2d2d7907b5
+  metadata.gz: 3d75e88719af0dce5ecee9e6063d2d25c9592038293ebc26340afd2c692e9c1f
+  data.tar.gz: 30b4a6d0d565c712c4781ff7115ff15e4c9a8cd2397b476bf60ffea91ef63208
 SHA512:
-  metadata.gz: 3a780d9bb80023f3c2350edb259cc45219e4acbb912381539e4a1bcf7c91307e2f858bba8f3c5eab484a5bb890b36a497fe41333204efcbe44c2a111ce5e3288
-  data.tar.gz: 7262ffab5f06d2e7423d6bff37bb8ae4aac44053aab3d9c0eef4a912db4af71a86858d490651e175b791d0ed90f81c914b2a46d761669353af23b169c395f657
+  metadata.gz: d2c380d494e0f6b2c094266e50c45b0faef5f51cac0b3bab76a1e32027a9e63adeaf4d63f6652e6ed2c56d0c797bc54d659fd124d5a000c13173401bee0eeb64
+  data.tar.gz: 6881dcef1d7f977aee13f837b5b8809cb7bdcbfe3b745f00d4c8af8cc198132c42419daf6bae2a171dafe92daf5d4349b08b57ee5451c192a4883b321ac3e5b9

data/lib/generators/jsonapi/swagger/swagger_generator.rb

@@ -50,6 +50,10 @@ module Jsonapi
       resource_klass._relationships
     end
 
+    def filters
+      resource_klass.filters
+    end
+
     def columns_with_comment
       @columns_with_comment ||= {}.tap do |clos|
         model_klass.columns.each do |col|
@@ -60,6 +64,7 @@ module Jsonapi
 
     def swagger_type(column)
       return 'array' if column.array
+
       case column.type
       when :bigint, :integer then 'integer'
       when :boolean          then 'boolean'

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

@@ -12,6 +12,9 @@ RSpec.describe '<%= resouces_name %>', type: :request do
       produces 'application/vnd.api+json'
       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
+<% filters.each do |filter_attr, filter_config| -%>
+      parameter name: :'filter[<%= filter_attr %>]', in: :query, type: :string, description: '<%= t(:filter_field) %>', <% if filter_config[:default] -%>default: '<%= safe_encode(filter_config[:default]) %>',<% end %>required: false
+<% end -%>
       parameter name: :'fields[<%= route_resouces %>]', 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
@@ -36,7 +39,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                     type: :object,
                     properties: {
 <% attributes.each_key.each do |attr| -%>
-                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, <%if columns_with_comment[attr][:is_array] -%> items: { type: :<%= columns_with_comment[attr][:items_type] %>},<% end -%> 'x-nullable': <%= columns_with_comment[attr][:nullable] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
+                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, <%if columns_with_comment[attr][:is_array] -%> items: { type: :<%= columns_with_comment[attr][:items_type] %>},<% end -%>'x-nullable': <%= columns_with_comment[attr][:nullable] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
 <% end -%>
                     },
                     description: '<%= t(:attributes) %>'
@@ -120,7 +123,7 @@ RSpec.describe '<%= resouces_name %>', type: :request do
                     type: :object,
                     properties: {
 <% attributes.each_key.each do |attr| -%>
-                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, <%if columns_with_comment[attr][:is_array] -%> items: { type: :<%= columns_with_comment[attr][:items_type] %>},<% end -%> 'x-nullable': <%= columns_with_comment[attr][:nullable] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
+                     <%= attr %>: { type: :<%= columns_with_comment[attr][:type] %>, <%if columns_with_comment[attr][:is_array] -%> items: { type: :<%= columns_with_comment[attr][:items_type] %>},<% end -%>'x-nullable': <%= columns_with_comment[attr][:nullable] %>, description: '<%= columns_with_comment[attr][:comment] %>'},
 <% end -%>
                     },
                     description: '<%= t(:attributes) %>'

data/lib/i18n/en.yml

@@ -3,6 +3,7 @@ en:
     page_num: 'Page Number'
     include_related_data: 'Include Related Data'
     display_field: 'Display Field'
+    filter_field: 'Filter Field'
     list: 'List'
     get_list: 'Fetch List'
     detail_link: 'Detail Link'

data/lib/i18n/zh-CN.yml

@@ -3,6 +3,7 @@ zh-CN:
     page_num: '页码'
     include_related_data: '包含关联数据'
     display_field: '显示字段'
+    filter_field: '过滤字段'
     list: '列表'
     get_list: '获取列表'
     detail_link: '详情链接'

data/lib/jsonapi/swagger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-swagger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - YingRui Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-28 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler