openapi_parameters 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e4a1690610c9bbbd5f901f5521b8d5c417d5679b2d3c22bf7c3b4fe5863a9a4
-  data.tar.gz: 37cadc3d8d9ff17c11082d1fe14db177b1778d14f0b89698fe5ad2292b5927db
+  metadata.gz: 52bca4aebd3d66fa0a3edc68d3ce71a24a223a31be135677a8fb9ea09a4055bc
+  data.tar.gz: '03230596b824ee0a59ca68048bcfc68e884af2cbbb3b14ea3952c1f917a7d87b'
 SHA512:
-  metadata.gz: b842ce9afd9246033103fddc51a26e888d9154eb4e694722f55c3ad3cb6a8226b3315e738411e71a21c516b5ef4f3bd8d86699d4638016b7c5aa5cec52b252c8
-  data.tar.gz: '09dd12da6978846a76a680fb22a859f339fb398bc3733682bf5924ff42d6de39e13b3f2f231552f777e175a1894fe9a915cd449dc7157b0ae2d37de21bd7b1b9'
+  metadata.gz: e5bf0752ef3be5d397cd5f5cee010a5e89fc4c1a1821ec0b86411fb1a97bfae8e81be46f5fa94d5bd47940c921f0a0dab9641f591f6ceddecfc856dd881f34d7
+  data.tar.gz: 8244a7c1c93ef4c0c2ee88374c4bb72f3f6295a11637fff60b02ad96e9015e702b284251eff003309ebdc0bb8f6ccf38f85334a9be7d6801bcd0b6f48cc5e808

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [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

@@ -34,6 +34,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.10.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.10.0
 platform: ruby
 authors:
 - Andreas Haller