grape-swagger 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9967e826af18b69a0b87166977ee09b1c3845ac614148b4664b9703156fc7226
-  data.tar.gz: df1b2b105532ff3a93af03919a75d476323f574e9493ee96760b3664b44df741
+  metadata.gz: c36235d1ec48b00075496c2d59151a87e42f2b7f34c876db913504a7706c1a70
+  data.tar.gz: 0d7aac2f325422f53218257e4cb8e2bef51e73e424a53d88b244c3073c614656
 SHA512:
-  metadata.gz: b387fb75c6148eece8ed8c9c057b5ec047c341b8ef5404f4aa3992c144eb7b11e320d76b0bee81bca7ceea56942b6b4b101089e003fcc967c95c64e45d1a30d0
-  data.tar.gz: dc275ae7d3c463a82b87d7674a0e3e28aa9154d751b9aae9d6a22f255df6b5ecd49688a69700bfa1306502418f832cdf9931e7384e4eb8771ed29650830e6069
+  metadata.gz: 13d4c18cf80ce43aedde8a3347be17ebda40fd6e2b56496459226f350e273b31cd6c74d79d75b68e2461d47dd6f0aeaec3080709aebbcf5b6beb9b8162f949bb
+  data.tar.gz: 949ebd6da1fcdb3c398e6070a035f50a9e211ed27a93694b275f5e09a9d1266c675f04f7b1e9583329689fcc9a38fd50cdac8dd6c1de87c486016e63faacce57

data/CHANGELOG.md

@@ -8,6 +8,23 @@
 
 * Your contribution here.
 
+
+### 2.0.3 (April 26, 2024)
+
+#### Fixes
+
+* [#922](https://github.com/ruby-grape/grape-swagger/pull/922): Force request body to be an schema object - [@numbata](https://github.com/numbata)
+* [#923](https://github.com/ruby-grape/grape-swagger/pull/923): Enabled schema definitions for body parameters in DELETE requests - [@numbata](https://github.com/numbata)
+* [#924](https://github.com/ruby-grape/grape-swagger/pull/924): fix: Use mount_path to narrow down urls_for - [@chibicco](https://github.com/chibicco)
+
+
+### 2.0.2 (Februar 2, 2024)
+
+#### Fixes
+
+* [#918](https://github.com/ruby-grape/grape-swagger/pull/918): Fix params extension does not work when param_type is body - [@numbata](https://github.com/numbata)
+
+
 ### 2.0.1 (Januar 2, 2024)
 
 #### Features
@@ -18,6 +35,7 @@
 
 * [#916](https://github.com/ruby-grape/grape-swagger/pull/916): Restore Ruby 3.0 support - [@godfat](https://github.com/godfat)
 
+
 ### 2.0.0 (November 7, 2023)
 
 #### Features
@@ -63,7 +81,6 @@
 * [#846](https://github.com/ruby-grape/grape-swagger/pull/846): Refactor oapi fetch task [@Vachman](https://github.com/Vachman)
 * [#850](https://github.com/ruby-grape/grape-swagger/pull/850): Fix value of enum to be Array [@takahashim](https://github.com/takahashim)
 
-
 ### 1.4.3 (January 5, 2022)
 
 #### Fixes

data/UPGRADING.md

@@ -1,5 +1,14 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= x.y.z
+
+- Grape-swagger now documents array parameters within an object schema in Swagger. This aligns with grape's JSON structure requirements and ensures the documentation is correct.
+  - Previously, arrays were documented as standalone arrays, which could be incorrect based on grape's expectations.
+  - Check your API documentation and update your code or tests that use the old array format.
+
+  Attention: This update may require you to make changes to ensure your API integrations continue to work correctly.
+  For detailed reasons behind this update, refer to GitHub issue #666.
+
 ### Upgrading to >= 1.5.0
 
 - The names generated for body parameter definitions and their references has changed. It'll now include the HTTP action as well as any path parameters.

data/lib/grape-swagger/doc_methods/move_params.rb

@@ -18,8 +18,6 @@ module GrapeSwagger
 
           params_to_move = movable_params(params)
 
-          return (params + correct_array_param(params_to_move)) if should_correct_array?(params_to_move)
-
           params << parent_definition_of_params(params_to_move, path, route)
 
           params
@@ -27,21 +25,11 @@ module GrapeSwagger
 
         private
 
-        def should_correct_array?(param)
-          param.length == 1 && param.first[:in] == 'body' && param.first[:type] == 'array'
-        end
-
-        def correct_array_param(param)
-          param.first[:schema] = { type: param.first.delete(:type), items: param.first.delete(:items) }
-
-          param
-        end
-
         def parent_definition_of_params(params, path, route)
           definition_name = OperationId.build(route, path)
-          build_definition(definition_name, params)
+          # NOTE: Parent definition is always object
+          @definitions[definition_name] = object_type
           definition = @definitions[definition_name]
-
           move_params_to_new(definition, params)
 
           definition[:description] = route.description if route.try(:description)
@@ -53,6 +41,7 @@ module GrapeSwagger
           params, nested_params = params.partition { |x| !x[:name].to_s.include?('[') }
           params.each do |param|
             property = param[:name]
+
             param_properties, param_required = build_properties([param])
             add_properties_to_definition(definition, param_properties, param_required)
             related_nested_params, nested_params = nested_params.partition { |x| x[:name].start_with?("#{property}[") }
@@ -86,6 +75,7 @@ module GrapeSwagger
                                else
                                  document_as_property(param)
                                end
+            add_extension_properties(properties[name], param)
 
             required << name if deletable?(param) && param[:required]
           end
@@ -102,6 +92,12 @@ module GrapeSwagger
           end
         end
 
+        def add_extension_properties(definition, values)
+          values.each do |key, value|
+            definition[key] = value if key.start_with?('x-')
+          end
+        end
+
         def document_as_property(param)
           property_keys.each_with_object({}) do |x, memo|
             next unless param.key?(x)
@@ -190,7 +186,7 @@ module GrapeSwagger
         end
 
         def move_methods
-          [:post, :put, :patch, 'POST', 'PUT', 'PATCH']
+          [:delete, :post, :put, :patch, 'DELETE', 'POST', 'PUT', 'PATCH']
         end
 
         def includes_body_param?(params)

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -70,7 +70,7 @@ module GrapeSwagger
 
         def document_array_param(value_type, definitions)
           if value_type[:documentation].present?
-            param_type = value_type[:documentation][:param_type]
+            param_type = value_type[:documentation][:param_type] || value_type[:documentation][:in]
             doc_type = value_type[:documentation][:type]
             type = DataType.mapping(doc_type) if doc_type && !DataType.request_primitive?(doc_type)
             collection_format = value_type[:documentation][:collectionFormat]
@@ -108,6 +108,10 @@ module GrapeSwagger
           set_additional_properties, additional_properties = parse_additional_properties(definitions, value_type)
           array_items[:additionalProperties] = additional_properties if set_additional_properties
 
+          if value_type.key?(:items)
+            GrapeSwagger::DocMethods::Extensions.add_extensions_to_root(value_type[:items], array_items)
+          end
+
           array_items
         end
 

data/lib/grape-swagger/rake/oapi_tasks.rb

@@ -63,7 +63,7 @@ module GrapeSwagger
           resource - if given only for that it would be generated (optional)'
         task validate: :environment do
           # :nocov:
-          ENV['store'] = 'true'
+          ENV.store('store', 'true')
           ::Rake::Task['oapi:fetch'].invoke
           exit if error?
 
@@ -95,7 +95,7 @@ module GrapeSwagger
       def urls_for(api_class)
         api_class.routes
                  .map(&:path)
-                 .select { |e| e.include?('doc') }
+                 .grep(/#{GrapeSwagger::DocMethods.class_variable_get(:@@mount_path)}/)
                  .reject { |e| e.include?(':name') }
                  .map { |e| format_path(e) }
                  .map { |e| [e, ENV.fetch('resource', nil)].join('/').chomp('/') }
@@ -108,7 +108,7 @@ module GrapeSwagger
       end
 
       def save_to_file?
-        ENV['store'].present? && !error?
+        ENV.fetch('store', nil).present? && !error?
       end
 
       def error?
@@ -118,10 +118,10 @@ module GrapeSwagger
       def file(url)
         api_version = url.split('/').last
 
-        name = if ENV['store'] == 'true' || ENV['store'].blank?
+        name = if ENV.fetch('store', nil) == 'true' || ENV.fetch('store', nil).blank?
                  "swagger_doc_#{api_version}.json"
                else
-                 ENV['store'].sub('.json', "_#{api_version}.json")
+                 ENV.fetch('store').sub('.json', "_#{api_version}.json")
                end
 
         File.join(Dir.getwd, name)

data/lib/grape-swagger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  VERSION = '2.0.1'
+  VERSION = '2.0.3'
 end

data/lib/grape-swagger.rb

@@ -40,7 +40,7 @@ module SwaggerRouting
       @target_class.combined_routes[resource] ||= []
       next if doc_klass.hide_documentation_path && route.path.match(/#{doc_klass.mount_path}($|\/|\(\.)/)
 
-      @target_class.combined_routes[resource].unshift route
+      @target_class.combined_routes[resource] << route
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - LeFnord
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-02 00:00:00.000000000 Z
+date: 2024-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed