rswag-specs 2.13.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4cbdf31d7dbcce5ecc58c58544873479a159a78e54b08717a32c17a246e017a
-  data.tar.gz: d136dbe25d2ad3abebaa9f25c54788d989ad77e060c7777dbde1a007831701cc
+  metadata.gz: 3d0a717ee80be6c37b90e1fc7ea402139c0e07d2972e6548c2aeffd1a1f86f07
+  data.tar.gz: ad12167354bfde937b5315657362adfb4d4930b76fb40ef3468c7fd08e2dbce7
 SHA512:
-  metadata.gz: 123ca088b4c0bf69c45c399c61b29af122631111cc22c3e83965521fc36561f076e90f94b6ee53eeea56625a6ee5d432939dbd31494fb4e66f5ceefebd077752
-  data.tar.gz: 155f8b3dbbc824751ae8e82e1ba25da43253aa40f76aff419473f1f97faa64026ffde966d5a23c7b01c98e577e4f4a183d4f4e9b6b04c585fe054103ce00d76e
+  metadata.gz: f725ad91cb4982da4ee8ce87c86b1677e4aefbb01727963cb9b847c6788cf00a6d62beda51af391a35d242ab5d54ea2201531792c522a2dd71ff295934040901
+  data.tar.gz: c3039e9a8176812533fdfa8564d2796b0273a2ad5f6d3ae0007054c5a3fb5be8199609a38b3a5a7397eb8eb8d95f764f5f62de8badfe9fddfa2bcfec346acad9

data/lib/rswag/specs/configuration.rb

@@ -61,6 +61,14 @@ module Rswag
       def openapi_strict_schema_validation
         @rspec_config.openapi_strict_schema_validation || false
       end
+
+      def openapi_all_properties_required
+        @rspec_config.openapi_all_properties_required || false
+      end
+
+      def openapi_no_additional_properties
+        @rspec_config.openapi_no_additional_properties || false
+      end
     end
 
     class ConfigurationError < StandardError; end

data/lib/rswag/specs/request_factory.rb

@@ -174,7 +174,7 @@ module Rswag
               return "#{escaped_name}=" + value.to_a.flatten.map{|v| CGI.escape(v.to_s) }.join(separator)
             end
           else
-            return "#{name}=#{value}"
+            return "#{escaped_name}=#{CGI.escape(value.to_s)}"
           end
         end
 
@@ -242,11 +242,13 @@ module Rswag
         content_type = request[:headers]['CONTENT_TYPE']
         return if content_type.nil?
 
-        if ['application/x-www-form-urlencoded', 'multipart/form-data'].include?(content_type)
-          request[:payload] = build_form_payload(parameters, example)
-        else
-          request[:payload] = build_json_payload(parameters, example)
-        end
+        request[:payload] = if ['application/x-www-form-urlencoded', 'multipart/form-data'].include?(content_type)
+                              build_form_payload(parameters, example)
+                            elsif content_type =~ /\Aapplication\/([0-9A-Za-z._-]+\+json\z|json\z)/
+                              build_json_payload(parameters, example)
+                            else
+                              build_raw_payload(parameters, example)
+                            end
       end
 
       def build_form_payload(parameters, example)
@@ -260,14 +262,17 @@ module Rswag
         Hash[tuples]
       end
 
-      def build_json_payload(parameters, example)
+      def build_raw_payload(parameters, example)
         body_param = parameters.select { |p| p[:in] == :body }.first
-
         return nil unless body_param
 
         raise(MissingParameterError, body_param[:name]) unless example.respond_to?(body_param[:name])
 
-        example.send(body_param[:name]).to_json
+        example.send(body_param[:name])
+      end
+
+      def build_json_payload(parameters, example)
+        build_raw_payload(parameters, example)&.to_json
       end
 
       def doc_version(doc)

data/lib/rswag/specs/response_validator.rb

@@ -73,14 +73,24 @@ module Rswag
       end
 
       def validation_options_from(metadata)
+        is_strict = @config.openapi_strict_schema_validation
+
         if metadata.key?(:swagger_strict_schema_validation)
-          Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: This option will be renamed to "openapi_strict_schema_validation" in v3.0')
+          Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: This option will be removed in v3.0 please use openapi_all_properties_required and openapi_no_additional_properties set to true')
           is_strict = !!metadata[:swagger_strict_schema_validation]
-        else
-          is_strict = !!metadata.fetch(:openapi_strict_schema_validation, @config.openapi_strict_schema_validation)
+        elsif metadata.key?(:openapi_strict_schema_validation)
+          Rswag::Specs.deprecator.warn('Rswag::Specs: WARNING: This option will be removed in v3.0 please use openapi_all_properties_required and openapi_no_additional_properties set to true')
+          is_strict = !!metadata[:openapi_strict_schema_validation]
         end
 
-        { strict: is_strict }
+        all_properties_required = metadata.fetch(:openapi_all_properties_required, @config.openapi_all_properties_required)
+        no_additional_properties = metadata.fetch(:openapi_no_additional_properties, @config.openapi_no_additional_properties)
+
+        {
+          strict: is_strict,
+          allPropertiesRequired: all_properties_required,
+          noAdditionalProperties: no_additional_properties
+        }
       end
 
       def definitions_or_component_schemas(swagger_doc, version)

data/lib/rswag/specs/swagger_formatter.rb

@@ -74,6 +74,11 @@ module Rswag
                     end
                   end
 
+                  enum_param = value.dig(:parameters).find{|p| p[:enum]}
+                  if enum_param && enum_param.is_a?(Hash)
+                    enum_param[:description] = generate_enum_description(enum_param)
+                  end
+
                   value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
                 end
                 remove_invalid_operation_keys!(value)
@@ -211,6 +216,14 @@ module Rswag
         value.delete(:request_examples) if value[:request_examples]
         value[:parameters].each { |p| p.delete(:getter) } if value[:parameters]
       end
+
+      def generate_enum_description(param)
+        enum_description = "#{param[:description]}:\n "
+        param[:enum].each do |k,v|
+          enum_description += "* `#{k}` #{v}\n "
+        end
+        enum_description
+      end
     end
   end
 end

data/lib/rswag/specs.rb

@@ -12,8 +12,7 @@ module Rswag
       swagger_root: :openapi_root,
       swagger_docs: :openapi_specs,
       swagger_dry_run: :rswag_dry_run,
-      swagger_format: :openapi_format,
-      swagger_strict_schema_validation: :openapi_strict_schema_validation
+      swagger_format: :openapi_format
     }.freeze
     private_constant :RENAMED_METHODS
 
@@ -24,6 +23,8 @@ module Rswag
       c.add_setting :rswag_dry_run
       c.add_setting :openapi_format, default: :json
       c.add_setting :openapi_strict_schema_validation
+      c.add_setting :openapi_all_properties_required
+      c.add_setting :openapi_no_additional_properties
       c.extend ExampleGroupHelpers, type: :request
       c.include ExampleHelpers, type: :request
     end
@@ -46,6 +47,10 @@ module Rswag
           public_send("#{new_name}=", *args, &block)
         end
       end
+
+      define_method('swagger_strict_schema_validation=') do |*args, &block|
+        public_send('openapi_strict_schema_validation=', *args, &block)
+      end
     end
 
     Specs.deprecator.deprecate_methods(
@@ -53,6 +58,11 @@ module Rswag
       RENAMED_METHODS.to_h { |old_name, new_name| ["#{old_name}=".to_sym, "#{new_name}=".to_sym] }
     )
 
+    Specs.deprecator.deprecate_methods(
+      RSpec::Core::Configuration,
+      :openapi_strict_schema_validation= => 'use openapi_all_properties_required and openapi_no_additional_properties set to true'
+    )
+
     if RUBY_VERSION.start_with? '2.6'
       Specs.deprecator.warn('Rswag::Specs: WARNING: Support for Ruby 2.6 will be dropped in v3.0')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,20 +18,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +41,7 @@ dependencies:
         version: '2.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,27 +51,27 @@ dependencies:
         version: '2.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: An OpenAPI-based (formerly called Swagger) DSL for rspec-rails & accompanying