rswag-specs 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 989468cbcebd005e6bf95724400366cfa1b80e7d395bb6d1255bc12c283a98b2
-  data.tar.gz: 949a822da86b5d6f3ead28cdd1262a093bcd8399875b1962f101c41634cc4c51
+  metadata.gz: cfedb2177ee21788aa710db72fbc573230a51c84877bd90edff99b8a1fc9967c
+  data.tar.gz: 842d0dba7c2dcd4aa59ec015928c825da6ef1cf892859e492589d540b003c181
 SHA512:
-  metadata.gz: b4cb982b39359a8f69dd5ebf18287a2b4941349a202751d10f936b81014fce8ec99a24886e5de63c4fb1d4aba653893cf4ebff9f425f547be99b1ac3910e53ad
-  data.tar.gz: 1064a439e5b8652c40a77eddd6d0837ea908780750187879bb8bdb11af67656ea6882a8a251bb8627001c7857ebad94c378d68432c1101e2e19647b5c7c29ae5
+  metadata.gz: 5640b7930547aa45a3b2662f8fad08508063d1c9726c2f72d6e2f15f6eab32408472e7645230b30a5eec74ae223cfae5e87e9d26311cc609aa543c90d8234aef
+  data.tar.gz: 98e797ce8b1babf942ba387cffbe6eec52994047543c669b9293631bc08bfc1695b9d3c1ca572f3ec9357e7649bf601f0df81bf28590ee605b501f7546aae8f1

data/lib/rswag/specs/example_group_helpers.rb

@@ -55,6 +55,18 @@ module Rswag
         end
       end
 
+
+      def request_body_example(value:, summary: nil, name: nil) 
+        if metadata.key?(:operation) 
+          metadata[:operation][:request_examples] ||= []
+          example = { value: value } 
+          example[:summary] = summary if summary 
+          # We need the examples to have a unique name for a set of examples, so just make the name the length if one isn't provided.
+          example[:name] = name || metadata[:operation][:request_examples].length()
+          metadata[:operation][:request_examples] << example
+        end 
+      end 
+
       def response(code, description, metadata = {}, &block)
         metadata[:response] = { code: code, description: description }
         context(description, metadata, &block)

data/lib/rswag/specs/request_factory.rb

@@ -148,7 +148,7 @@ module Rswag
           style = param[:style]&.to_sym || :form
           explode = param[:explode].nil? ? true : param[:explode]
 
-          case param[:schema][:type].to_sym
+          case param[:schema][:type]&.to_sym
           when :object
             case style
             when :deepObject
@@ -213,14 +213,22 @@ module Rswag
           tuples << ['Content-Type', content_type]
         end
 
+        # Host header
+        host = metadata[:operation][:host] || swagger_doc[:host]
+        if host.present?
+          host = example.respond_to?(:'Host') ? example.send(:'Host') : host
+          tuples << ['Host', host]
+        end
+
         # Rails test infrastructure requires rack-formatted headers
         rack_formatted_tuples = tuples.map do |pair|
           [
             case pair[0]
-            when 'Accept' then 'HTTP_ACCEPT'
-            when 'Content-Type' then 'CONTENT_TYPE'
-            when 'Authorization' then 'HTTP_AUTHORIZATION'
-            else pair[0]
+              when 'Accept' then 'HTTP_ACCEPT'
+              when 'Content-Type' then 'CONTENT_TYPE'
+              when 'Authorization' then 'HTTP_AUTHORIZATION'
+              when 'Host' then 'HTTP_HOST'
+              else pair[0]
             end,
             pair[1]
           ]

data/lib/rswag/specs/response_validator.rb

@@ -32,9 +32,22 @@ module Rswag
       end
 
       def validate_headers!(metadata, headers)
-        expected = (metadata[:response][:headers] || {}).keys
+        header_schemas = (metadata[:response][:headers] || {})
+        expected = header_schemas.keys
         expected.each do |name|
-          raise UnexpectedResponse, "Expected response header #{name} to be present" if headers[name.to_s].nil?
+          nullable_attribute = header_schemas.dig(name.to_s, :schema, :nullable)
+          required_attribute = header_schemas.dig(name.to_s, :required)
+
+          is_nullable = nullable_attribute.nil? ? false : nullable_attribute
+          is_required = required_attribute.nil? ? true : required_attribute
+
+          if headers.exclude?(name.to_s) && is_required
+            raise UnexpectedResponse, "Expected response header #{name} to be present"
+          end
+
+          if headers.include?(name.to_s) && headers[name.to_s].nil? && !is_nullable
+            raise UnexpectedResponse, "Expected response header #{name} to not be null"
+          end
         end
       end
 

data/lib/rswag/specs/swagger_formatter.rb

@@ -62,8 +62,18 @@ module Rswag
                     value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
                     value[:requestBody][:required] = true if schema_param[:required]
                     value[:requestBody][:description] = schema_param[:description] if schema_param[:description]
+                    examples = value.dig(:request_examples)
                     mime_list.each do |mime|
                       value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
+                      if examples
+                        value[:requestBody][:content][mime][:examples] ||= {}
+                        examples.map do |example|
+                          value[:requestBody][:content][mime][:examples][example[:name]] = {
+                            summary: example[:summary] || value[:summary],
+                            value: example[:value]
+                          }
+                        end
+                      end
                     end
                   end
 
@@ -200,6 +210,7 @@ module Rswag
         is_hash = value.is_a?(Hash)
         value.delete(:consumes) if is_hash && value[:consumes]
         value.delete(:produces) if is_hash && value[:produces]
+        value.delete(:request_examples) if is_hash && value[:request_examples]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rswag-specs
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Richie Morris
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport