openapi_parameters 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e4a1690610c9bbbd5f901f5521b8d5c417d5679b2d3c22bf7c3b4fe5863a9a4
-  data.tar.gz: 37cadc3d8d9ff17c11082d1fe14db177b1778d14f0b89698fe5ad2292b5927db
+  metadata.gz: c60c99ee16620da86f7369bd56aba581bb01b330f964f996c1c87ef9d6262ef3
+  data.tar.gz: 295645007a994719cbab03c8b6d7067814694b99db6c8ef0063157a50357c073
 SHA512:
-  metadata.gz: b842ce9afd9246033103fddc51a26e888d9154eb4e694722f55c3ad3cb6a8226b3315e738411e71a21c516b5ef4f3bd8d86699d4638016b7c5aa5cec52b252c8
-  data.tar.gz: '09dd12da6978846a76a680fb22a859f339fb398bc3733682bf5924ff42d6de39e13b3f2f231552f777e175a1894fe9a915cd449dc7157b0ae2d37de21bd7b1b9'
+  metadata.gz: ef68be758fbd8675edcb35b6abdb89da197b76f8be22b47d0fb6e79a6fbe120a43332e46fdeae2f428f90db77d8c13c7ba129874554e8747ef714c73cc9a84fc
+  data.tar.gz: cb1e43539392572a521ec67880ff44ee5dc94374ff82087513206dbd9e54e1113997344235372da5eb592da1c07e3ae82a2167a31fc042ba59fc24021b056b34

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.11.0] - 2025-11-30
+
+- Changed:  Passing a plain query string like `filter=ada` to a`deepObject` parameter instead of using the brackets syntax `filter[name]=ada` no longer results in an empty object, but in the plain string value (like `{ filter: 'ada'} `), which will make request validation fail.
+
+## [0.10.0] - 2025-11-23
+
+- remove `OpenapiParameters::Parameter#definition` to clean up interface
+- Add `OpenapiParameters::Query#unknown_values` to find unknown query parameters
+
 ## [0.9.0] - 2025-11-07
 
 - Add support for unpacking query parameters that use deepObject and oneOf,andOf,anyOf,if-them-else

data/README.md

@@ -28,6 +28,10 @@ query_parameters = OpenapiParameters::Query.new([{
 query_string = env['QUERY_STRING'] # => 'ids=1&ids=2'
 query_parameters.unpack(query_string) # => { 'ids' => [1, 2] }
 
+# Find unknown query parameters
+# Note that this does only return unknown top-level values 
+query_parameters.unknown_values('ids=1&ids=2&foo=bar') # => { 'foo' => 'bar' }
+
 path_parameters = OpenapiParameters::Path.new(parameters)
 route_params = env['route.params'] # This depends on the webframework you are using
 path_parameters.unpack(route_params) # => { 'ids' => [1, 2, 3] }

data/lib/openapi_parameters/parameter.rb

@@ -13,7 +13,8 @@ module OpenapiParameters
       check_supported!
     end
 
-    attr_reader :definition, :name
+    attr_reader :name
+    private attr_reader :definition
 
     def convert(value)
       @converter.call(value)

data/lib/openapi_parameters/query.rb

@@ -18,8 +18,12 @@ module OpenapiParameters
       parsed_query = parse_query(query_string)
       parameters.each_with_object({}) do |parameter, result|
         if parameter.deep_object?
-          value = parse_deep_object(parameter, parsed_query)
-          next if value.empty?
+          if parsed_query.key?(parameter.name)
+            value = parsed_query[parameter.name]
+          else
+            value = parse_deep_object(parameter, parsed_query)
+            next if value.empty?
+          end
         else
           next unless parsed_query.key?(parameter.name)
 
@@ -34,6 +38,24 @@ module OpenapiParameters
       end
     end
 
+    def unknown_values(query_string)
+      parsed_query = parse_query(query_string)
+      known_parameter_names = parameters.to_set(&:name)
+
+      unknown = parsed_query.each_with_object({}) do |(key, value), result|
+        # Skip parameters that are defined in the schema
+        next if known_parameter_names.include?(key)
+
+        # Skip deep object parameters that might belong to defined parameters
+        next if parameters.any? { |param| param.deep_object? && key.start_with?("#{param.name}[") }
+
+        result[key] = value
+      end
+      return if unknown.empty?
+
+      unknown
+    end
+
     attr_reader :parameters
     private attr_reader :remove_array_brackets, :parameter_property_schemas
 

data/lib/openapi_parameters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiParameters
-  VERSION = '0.9.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parameters
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Andreas Haller