rswag-specs 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4cbdf31d7dbcce5ecc58c58544873479a159a78e54b08717a32c17a246e017a
-  data.tar.gz: d136dbe25d2ad3abebaa9f25c54788d989ad77e060c7777dbde1a007831701cc
+  metadata.gz: 632bdf59bdc4251188267dec82987bd14466f625e34e54501383a298081c9cdc
+  data.tar.gz: 19f715a56062c2aaa9bd6db80392e154a6f7ebcac70077d2e59c38fe614baf77
 SHA512:
-  metadata.gz: 123ca088b4c0bf69c45c399c61b29af122631111cc22c3e83965521fc36561f076e90f94b6ee53eeea56625a6ee5d432939dbd31494fb4e66f5ceefebd077752
-  data.tar.gz: 155f8b3dbbc824751ae8e82e1ba25da43253aa40f76aff419473f1f97faa64026ffde966d5a23c7b01c98e577e4f4a183d4f4e9b6b04c585fe054103ce00d76e
+  metadata.gz: 02fcf0b9b5f42f837c434badc4275a72fd6789fbe973dbb703dcfaf0237699cb008b8c7ce51e4ba150429717e714a9b741d4788257a6ba09d8b06ef617521f0b
+  data.tar.gz: 79c42771f6131b91ab849c770a6c2ef9461d54737059b4b24c03ca85a20e1c82fd26cf9ea4eb92d03f914ed3126b4e4c0571cea81e69ad89453d63d1441088a2

data/lib/rswag/specs/request_factory.rb

@@ -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 == 'application/json'
+                              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/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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.14.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-08-13 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
@@ -58,20 +58,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: 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