zero-rails_openapi 1.5.9 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08be41261a50ecc6ed82129ba00cfdbd39bfe642db60bb8822891c40592ef26c'
-  data.tar.gz: 21f231545cb2be40dae468179d1d6a30365a2b8209319a853055122a004ab5f5
+  metadata.gz: f02e4f2dff6974c8ea59e4e410e695f27d7395a417612003525ed6fa250c008a
+  data.tar.gz: 23e2eb595a89c71e3f417b295d107de43d9cf5e3af917329715d69fe42846a0f
 SHA512:
-  metadata.gz: 17041c2c4b9a9eb34475d2d7139f27a5c5871c0f9d713c3c8a4b4cff6be5ad2b348f7b6902cf55b348e5e2742d77a42f75cd12301475753b7519f65ced912c96
-  data.tar.gz: cf3c94e723cf771173f20ea2b9e1db18bcc0b29b10de9c8ca76ccefe4b1f2f845de444e1effbd0a5eac29db7313030daa85ed05a5082df77c420dd4cf8fc791f
+  metadata.gz: de28674280308d143a856a82cdc7fee995b1a506ac4b0342ff9721d3656637f87444c4ff69f4967e8a839e36598797e1559f41a02145c24bce8c823916bc1318
+  data.tar.gz: ccea172bdb47b90b97f423ac0d6a744e996de455c6fc1a82cf3ba22a12126978e0ff13278d8737ddc4f699065980fb755c2776bf6f98e695598ac74cba357619

data/CHANGELOG.md

@@ -2,15 +2,33 @@
 
 ## [Unreleased]
 
+## [1.6.0] - 2018/6/26 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.9...v1.6.0)
+
+## Changed
+
+1. issue [#21](https://github.com/zhandao/zero-rails_openapi/issues/21) support additionalProperties. Thanks @barnaclebarnes
+2. issue [#23](https://github.com/zhandao/zero-rails_openapi/issues/23) Uniqueness of operationId. Thanks @barnaclebarnes
+
+## Fixed
+
+1. issue [#22](https://github.com/zhandao/zero-rails_openapi/issues/22) missing `/` in reference. Thanks @barnaclebarnes
+
+## [1.5.8 & 1.5.9] - 2018/6/19 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.7...v1.5.9)
+
+## Changed
+
+1. issue [#17](https://github.com/zhandao/zero-rails_openapi/issues/17) singular example in schema. Thanks @williamdias
+1. issue [#18](https://github.com/zhandao/zero-rails_openapi/issues/18) define multiple components blocks in one class. Thanks @Amnesthesia
+
 ## [1.5.7] - 2018/4/6 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.6...v1.5.7)
 
 ## Changed
 
-1. issue [#16](https://github.com/zhandao/zero-rails_openapi/issues/16) DSL in `base_doc_class` can not be generated.
+1. issue [#16](https://github.com/zhandao/zero-rails_openapi/issues/16) DSL in `base_doc_class` can not be generated. Thanks @jonathantribouharet
 
 ## Fixed
 
-1. issue [#15](https://github.com/zhandao/zero-rails_openapi/issues/15) colorize was not required.
+1. issue [#15](https://github.com/zhandao/zero-rails_openapi/issues/15) colorize was not required. Thanks @jonathantribouharet
 2. securitySchemes defined by config DSL was not be generated.
 
 ## [1.5.6] - 2018/3/23 - [view diff](https://github.com/zhandao/zero-rails_openapi/compare/v1.5.5...v1.5.6)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    zero-rails_openapi (1.5.9)
+    zero-rails_openapi (1.6.0)
       activesupport (>= 3)
       colorize
       rails (>= 3)

data/lib/oas_objs/ref_obj.rb

@@ -9,7 +9,7 @@ module OpenApi
       attr_accessor :processed
       def initialize(ref_to, component_key)
         self.processed = {
-            '$ref': "#components/#{ref_to.to_s.pluralize}/#{component_key}"
+            '$ref': "#/components/#{ref_to.to_s.pluralize}/#{component_key}"
         }
       end
 

data/lib/oas_objs/schema_obj.rb

@@ -22,7 +22,7 @@ module OpenApi
 
       def process(options = { inside_desc: false })
         processed.merge!(processed_type)
-        reducx(enum_and_length, range, format, pattern_default_and_other, desc(options)).then_merge!
+        reducx(additional_properties, enum_and_length, range, format, pattern_default_and_other, desc(options)).then_merge!
       end
 
       def desc(inside_desc:)
@@ -47,11 +47,21 @@ module OpenApi
           { type: 'string', format: Config.file_format }
         elsif t == 'datetime'
           { type: 'string', format: 'date-time' }
+        elsif t.match?(/\{=>.*\}/)
+          self[:values_type] = t[3..-2]
+          { type: 'object' }
         else # other string
           { type: t }
         end
       end
 
+      def additional_properties
+        return { } if processed[:type] != 'object' || _addProp.nil?
+        {
+            additionalProperties: SchemaObj.new(_addProp, { }).process(inside_desc: true)
+        }
+      end
+
       def enum_and_length
         process_enum_info
         process_range_enum_and_lth
@@ -112,6 +122,7 @@ module OpenApi
           __desc:   %i[ desc!    description! d!          ],
           _exp:     %i[ example                           ],
           _exps:    %i[ examples                          ],
+          _addProp: %i[ additional_properties add_prop values_type ],
           _is:      %i[ is_a     is                       ], # NOT OAS Spec, see documentation/parameter.md
           _as:      %i[ as   to  for     map  mapping     ], # NOT OAS Spec, it's for zero-params_processor
           _permit:  %i[ permit   pmt                      ], # ditto

data/lib/open_api/dsl.rb

@@ -34,7 +34,7 @@ module OpenApi
         (@doc_info[:components] ||= { }).deep_merge!(current_doc)
       end
 
-      def api action, summary = '', http: http_method = nil, skip: [ ], use: [ ], &block
+      def api action, summary = '', id: nil, http: http_method = nil, skip: [ ], use: [ ], &block
         doc_tag if @doc_info.nil?
         # select the routing info (corresponding to the current method) from routing list.
         action_path = "#{@route_base ||= controller_path}##{action}"
@@ -42,8 +42,8 @@ module OpenApi
         return puts '    ZRO'.red + " Route mapping failed: #{action_path}" if routes.blank?
 
         api = Api.new(action_path, skip: Array(skip), use: Array(use))
-                 .merge! description: '', summary: summary, operationId: action, tags: [@doc_tag],
-                         parameters: [ ], requestBody: '',  responses: { },  callbacks: { },
+                 .merge! description: '', summary: summary, operationId: id || "#{@doc_info[:tag][:name]}_#{action}",
+                         tags: [@doc_tag], parameters: [ ], requestBody: '',  responses: { },  callbacks: { },
                          links: { }, security: [ ], servers: [ ]
         [action, :all].each { |blk_key| @zro_dry_blocks&.[](blk_key)&.each { |blk| api.instance_eval(&blk) } }
         api.param_use = api.param_skip = [ ] # `skip` and `use` only affect `api_dry`'s blocks

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.5.9'
+  VERSION = '1.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-19 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler