From 7b01ae1aa14c41356b231f60da3149be58788599 Mon Sep 17 00:00:00 2001
From: Igor Kapkov <igasgeek@me.com>
Date: Wed, 22 Jan 2020 15:54:24 +1100
Subject: [PATCH 01/61] Add ENV var to configure --dry-run

---
 rswag-specs/lib/rswag/specs/configuration.rb | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/configuration.rb b/rswag-specs/lib/rswag/specs/configuration.rb
index 4c6ee6827..8743198e1 100644
--- a/rswag-specs/lib/rswag/specs/configuration.rb
+++ b/rswag-specs/lib/rswag/specs/configuration.rb
@@ -26,9 +26,11 @@ def swagger_docs
       end
 
       def swagger_dry_run
-        @swagger_dry_run ||= begin
-          @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
+        return @swagger_dry_run if defined? @swagger_dry_run
+        if ENV.key?('SWAGGER_DRY_RUN')
+          @rspec_config.swagger_dry_run = ENV['SWAGGER_DRY_RUN'] == '1'
         end
+        @swagger_dry_run = @rspec_config.swagger_dry_run.nil? || @rspec_config.swagger_dry_run
       end
 
       def swagger_format

From 56eec5948e9d58e798cb759ee6cc3f59a21e60cd Mon Sep 17 00:00:00 2001
From: Igor Kapkov <igasgeek@me.com>
Date: Wed, 25 Mar 2020 16:57:58 +1100
Subject: [PATCH 02/61] Update readme

---
 README.md | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 5018d3afd..1f0c8b938 100644
--- a/README.md
+++ b/README.md
@@ -452,14 +452,15 @@ after do |example|
   example.metadata[:response][:examples] = { 'application/json' => JSON.parse(response.body, symbolize_names: true) }
 end
 ```
-You need to disable --dry-run option for Rspec > 3
+You need to disable `--dry-run` option for Rspec > 3. You can do one of the following:
 
-Add to application.rb:
-```ruby
-RSpec.configure do |config|
-  config.swagger_dry_run = false
-end
-```
+- use environment varible `SWAGGER_DRY_RUN` set to `1` during generation command
+- or add the following to your `application.rb`:
+  ```ruby
+  RSpec.configure do |config|
+    config.swagger_dry_run = false
+  end
+  ```
 
 ### Running tests without documenting ###
 

From f8dbd98bbc877710edd2f249364c517099f42a7a Mon Sep 17 00:00:00 2001
From: Gabriel Sobrinho <gabriel.sobrinho@gmail.com>
Date: Thu, 16 Apr 2020 22:00:55 -0300
Subject: [PATCH 03/61] Add a macro for complexes multiparts

This will allow to describe multipart in a short way, like JSON payload:

Before:

    put 'Creates a blog with thumbnail' do
      consumes 'multipart/form-data'
      parameter name: :title, in: :formData, type: :string, required: true
      parameter name: :content, in: :formData, type: :string, required: true
      parameter name: :file, in: :formData, type: :file, required: true

      let(:blog) { FactoryBot.build(:blog) }
      let(:title) { blog.title }
      let(:content) { blog.content }
      let(:file) { blog.file }

      ...
    end

After:

    put 'Creates a blog with thumbnail' do
      consumes 'multipart/form-data'
      parameter name: :blog, in: :formData, schema: { '$ref' => '#/definitions/blog' }

      let(:blog) { FactoryBot.attributes_for(:blog) }

      ...
    end

Your mileage may vary but you can always choose the best option.
---
 .../lib/rswag/specs/request_factory.rb        | 16 ++++++-
 .../spec/rswag/specs/request_factory_spec.rb  | 14 ++++++
 test-app/app/controllers/blogs_controller.rb  |  6 +++
 test-app/config/routes.rb                     |  1 +
 test-app/spec/features/swagger_ui_spec.rb     |  1 +
 test-app/spec/integration/blogs_spec.rb       | 27 +++++++++++
 test-app/swagger/v1/swagger.json              | 46 +++++++++++++++++++
 7 files changed, 110 insertions(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index 2e8f3f1da..e3158362b 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -185,8 +185,22 @@ def build_form_payload(parameters, example)
         # Rather that serializing with the appropriate encoding (e.g. multipart/form-data),
         # Rails test infrastructure allows us to send the values directly as a hash
         # PROS: simple to implement, CONS: serialization/deserialization is bypassed in test
+        smart_payload = build_smart_form_payload(parameters, example)
+        raw_payload = build_raw_form_payload(parameters, example)
+
+        smart_payload.merge(raw_payload)
+      end
+
+      def build_smart_form_payload(parameters, example)
+        smart_tuples = parameters
+          .select { |p| p[:in] == :formData && p[:schema] }
+          .map { |p| example.send(p[:name]) }
+          .reduce({}, :merge)
+      end
+
+      def build_raw_form_payload(parameters, example)
         tuples = parameters
-          .select { |p| p[:in] == :formData }
+          .select { |p| p[:in] == :formData && !p[:schema] }
           .map { |p| [p[:name], example.send(p[:name])] }
         Hash[tuples]
       end
diff --git a/rswag-specs/spec/rswag/specs/request_factory_spec.rb b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
index aff5fb4eb..0269bd82d 100644
--- a/rswag-specs/spec/rswag/specs/request_factory_spec.rb
+++ b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
@@ -178,6 +178,20 @@ module Specs
               )
             end
           end
+
+          context 'smart form payload' do
+            before do
+              metadata[:operation][:consumes] = ['multipart/form-data']
+              metadata[:operation][:parameters] = [{ name: 'comment', in: :formData, schema: { type: 'object' } }]
+              allow(example).to receive(:comment).and_return(text: 'Some comment')
+            end
+
+            it 'sets payload to hash of names and example values' do
+              expect(request[:payload]).to eq(
+                :text => 'Some comment'
+              )
+            end
+          end
         end
 
         context 'produces content' do
diff --git a/test-app/app/controllers/blogs_controller.rb b/test-app/app/controllers/blogs_controller.rb
index 75c5ca735..5307baf1d 100644
--- a/test-app/app/controllers/blogs_controller.rb
+++ b/test-app/app/controllers/blogs_controller.rb
@@ -8,6 +8,12 @@ def create
     respond_with @blog
   end
 
+  # POST /blogs/multipart
+  def multipart_create
+    @blog = Blog.create(params.require(:blog).permit(:title, :content))
+    respond_with @blog
+  end
+
   # POST /blogs/flexible
   def flexible_create
 
diff --git a/test-app/config/routes.rb b/test-app/config/routes.rb
index 038f728eb..e9b611f1d 100644
--- a/test-app/config/routes.rb
+++ b/test-app/config/routes.rb
@@ -1,5 +1,6 @@
 TestApp::Application.routes.draw do
 
+  post '/blogs/multipart', to: 'blogs#multipart_create'
   post '/blogs/flexible', to: 'blogs#flexible_create'
   post '/blogs/alternate', to: 'blogs#alternate_create'
   resources :blogs
diff --git a/test-app/spec/features/swagger_ui_spec.rb b/test-app/spec/features/swagger_ui_spec.rb
index 484ad657a..e09df2120 100644
--- a/test-app/spec/features/swagger_ui_spec.rb
+++ b/test-app/spec/features/swagger_ui_spec.rb
@@ -7,6 +7,7 @@
 
     expect(page).to have_content('GET /blogs Searches blogs', normalize_ws: true)
     expect(page).to have_content('POST /blogs Creates a blog', normalize_ws: true)
+    expect(page).to have_content('POST /blogs/multipart Creates a blog using multipart', normalize_ws: true)
     expect(page).to have_content('GET /blogs/{id} Retrieves a blog', normalize_ws: true)
   end
 end
diff --git a/test-app/spec/integration/blogs_spec.rb b/test-app/spec/integration/blogs_spec.rb
index ee4a67ef9..d19270a32 100644
--- a/test-app/spec/integration/blogs_spec.rb
+++ b/test-app/spec/integration/blogs_spec.rb
@@ -49,6 +49,33 @@
     end
   end
 
+  path '/blogs/multipart' do
+    post 'Creates a blog using multipart' do
+      tags 'Blogs'
+      description 'Creates a new blog from provided data'
+      operationId 'createBlogWithMultipart'
+      consumes 'multipart/form-data'
+      produces 'application/json'
+      parameter name: :blog, in: :formData, schema: { type: :object, properties: { name: :blog, type: :object, properties: { '$ref' => '#/definitions/blog' } } }
+
+      let(:blog) { { blog: { title: 'foo', content: 'bar' } } }
+
+      response '201', 'blog created' do
+        # schema '$ref' => '#/definitions/blog'
+        run_test!
+      end
+
+      response '422', 'invalid request' do
+        schema '$ref' => '#/definitions/errors_object'
+
+        let(:blog) { { blog: { title: 'foo' } } }
+        run_test! do |response|
+          expect(response.body).to include("can't be blank")
+        end
+      end
+    end
+  end
+
   path '/blogs/flexible' do
     post 'Creates a blog flexible body' do
       tags 'Blogs'
diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 957206cd9..32674b50a 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -155,6 +155,52 @@
         }
       }
     },
+    "/blogs/multipart": {
+      "post": {
+        "summary": "Creates a blog using multipart",
+        "tags": [
+          "Blogs"
+        ],
+        "description": "Creates a new blog from provided data",
+        "operationId": "createBlogWithMultipart",
+        "parameters": [
+
+        ],
+        "responses": {
+          "201": {
+            "description": "blog created",
+            "content": {
+            }
+          },
+          "422": {
+            "description": "invalid request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/definitions/errors_object"
+                }
+              }
+            }
+          }
+        },
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": "blog",
+                  "type": "object",
+                  "properties": {
+                    "$ref": "#/definitions/blog"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/blogs/flexible": {
       "post": {
         "summary": "Creates a blog flexible body",

From 9c297317b2eeb4b4ebaca76c85210fddd56d97f2 Mon Sep 17 00:00:00 2001
From: Oleg Yakovenko <olegykz@gmail.com>
Date: Thu, 4 Jun 2020 16:21:43 +0300
Subject: [PATCH 04/61] keep examples content

---
 README.md                                     | 43 ++++++++++---------
 .../lib/generators/rspec/templates/spec.rb    |  6 ++-
 .../lib/rswag/specs/swagger_formatter.rb      |  4 +-
 3 files changed, 30 insertions(+), 23 deletions(-)

diff --git a/README.md b/README.md
index fd3f05c93..a0c5024ca 100644
--- a/README.md
+++ b/README.md
@@ -363,8 +363,8 @@ you should use the folowing syntax, making sure there are no whitespaces at the
 
 ### Specifying/Testing API Security ###
 
-Swagger allows for the specification of different security schemes and their applicability to operations in an API. 
-To leverage this in rswag, you define the schemes globally in _swagger_helper.rb_ and then use the "security" attribute at the operation level to specify which schemes, if any, are applicable to that operation. 
+Swagger allows for the specification of different security schemes and their applicability to operations in an API.
+To leverage this in rswag, you define the schemes globally in _swagger_helper.rb_ and then use the "security" attribute at the operation level to specify which schemes, if any, are applicable to that operation.
 Swagger supports :basic, :bearer, :apiKey and :oauth2 and :openIdConnect scheme types. See [the spec](https://swagger.io/docs/specification/authentication/) for more info, as this underwent major changes between Swagger 2.0 and Open API 3.0
 
 ```ruby
@@ -416,7 +416,7 @@ describe 'Blogs API' do
 end
 
 # example of documenting an endpoint that handles basic auth and api key based security
-describe 'Auth examples API' do 
+describe 'Auth examples API' do
   path '/auth-tests/basic-and-api-key' do
     post 'Authenticates with basic auth and api key' do
       tags 'Auth Tests'
@@ -437,11 +437,11 @@ describe 'Auth examples API' do
     end
   end
 end
- 
+
 
 ```
 
-__NOTE:__ Depending on the scheme types, you'll be required to assign a corresponding parameter value with each example. 
+__NOTE:__ Depending on the scheme types, you'll be required to assign a corresponding parameter value with each example.
 For example, :basic auth is required above and so the :Authorization (header) parameter must be set accordingly
 
 ## Configuration & Customization ##
@@ -479,9 +479,9 @@ rake rswag:specs:swaggerize PATTERN="spec/swagger/**/*_spec.rb"
 
 ### Referenced Parameters and Schema Definitions ###
 
-Swagger allows you to describe JSON structures inline with your operation descriptions OR as referenced globals. 
+Swagger allows you to describe JSON structures inline with your operation descriptions OR as referenced globals.
 For example, you might have a standard response structure for all failed operations.
-Again, this is a structure that changed since swagger 2.0. Notice the new "schemas" section for these. 
+Again, this is a structure that changed since swagger 2.0. Notice the new "schemas" section for these.
 Rather than repeating the schema in every operation spec, you can define it globally and provide a reference to it in each spec:
 
 ```ruby
@@ -549,7 +549,7 @@ end
 
 ### Response headers ###
 
-In Rswag, you could use `header` method inside the response block to specify header objects for this response. 
+In Rswag, you could use `header` method inside the response block to specify header objects for this response.
 Rswag will validate your response headers with those header objects and inject them into the generated swagger file:
 
 ```ruby
@@ -597,16 +597,20 @@ To enable examples generation from responses add callback above run_test! like:
 
 ```
 after do |example|
-  example.metadata[:response][:examples] = { 'application/json' => JSON.parse(response.body, symbolize_names: true) }
+  example.metadata[:response][:content] = {
+    'application/json' => {
+      example: JSON.parse(response.body, symbolize_names: true)
+    }
+  }
 end
 ```
 
 You need to disable --dry-run option for Rspec > 3
 
-<!-- This is now enabled by default in rswag. 
+<!-- This is now enabled by default in rswag.
 You need to set the ``` config.swagger_dry_run = false``` value in the spec/spec_helper.rb file.
 This is one of the more powerful features of rswag. When rswag runs your integration test suite via ```bundle exec rspec```, it will capture the request and response bodies and output those values in the examples section.
-These integration tests are usually written with ```let``` variables for post body parameters, and since its an integration test the service is returning actual values. 
+These integration tests are usually written with ```let``` variables for post body parameters, and since its an integration test the service is returning actual values.
 We might as well re-use these values and embed them into the generated swagger to provide a more real world example for request/response examples. -->
 
 Add to config/environments/test.rb:
@@ -645,8 +649,8 @@ describe 'Blogs API', document: false do
 ```
 
 ##### rswag helper methods #####
-<!-- 
-There are some helper methods to help with documenting request bodies. 
+<!--
+There are some helper methods to help with documenting request bodies.
 ```ruby
 describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
   let(:api_key) { 'fake_key' }
@@ -682,7 +686,7 @@ describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
       end
     end
   end
-end    
+end
 ```
 
 In the above example, we see methods ```request_body_json``` ```request_body_plain``` ```request_body_xml```.
@@ -692,7 +696,7 @@ and the examples: :blog which will create a named example "blog" under the "requ
 Again, documenting request response examples changed in Open API 3.0. The example above would generate a swagger.json snippet that looks like this:
 
 ```json
-        ... 
+        ...
         {"requestBody": {
           "required": true,
           "content": {
@@ -726,9 +730,9 @@ Again, documenting request response examples changed in Open API 3.0. The exampl
         }
 ```
 
-*NOTE:* for this example request body to work in the tests properly, you need to ``let`` a variable named *blog*. 
+*NOTE:* for this example request body to work in the tests properly, you need to ``let`` a variable named *blog*.
 The variable with the matching name (blog in this case) is eval-ed and captured to be placed in the examples section.
-This ```let``` value is used in the integration test to run the test AND captured and injected into the requestBody section. 
+This ```let``` value is used in the integration test to run the test AND captured and injected into the requestBody section.
 
 ##### rswag response examples #####
 
@@ -826,7 +830,7 @@ You can specify custom headers for serving your generated Swagger JSON. For exam
 ```ruby
 Rswag::Api.configure do |c|
   ...
-  
+
   c.swagger_headers = { 'Content-Type' => 'application/json; charset=UTF-8' }
 end
 ```
@@ -898,6 +902,5 @@ docker pull swaggerapi/swagger-editor
 ```
 docker run -d -p 80:8080 swaggerapi/swagger-editor
 ```
-This will run the swagger editor in the docker daemon and can be accessed 
+This will run the swagger editor in the docker daemon and can be accessed
 at ```http://localhost```. From here, you can use the UI to load the generated swagger.json to validate the output.
-
diff --git a/rswag-specs/lib/generators/rspec/templates/spec.rb b/rswag-specs/lib/generators/rspec/templates/spec.rb
index 346e34843..de3bac5e0 100644
--- a/rswag-specs/lib/generators/rspec/templates/spec.rb
+++ b/rswag-specs/lib/generators/rspec/templates/spec.rb
@@ -19,7 +19,11 @@
 <%      end -%>
 
         after do |example|
-          example.metadata[:response][:examples] = { 'application/json' => JSON.parse(response.body, symbolize_names: true) }
+          example.metadata[:response][:content] = {
+            'application/json' => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
         end
         run_test!
       end
diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 0b15f1236..2fa7e9395 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -129,13 +129,13 @@ def upgrade_response_produces!(swagger_doc, metadata)
       end
 
       def upgrade_content!(mime_list, target_node)
-        target_node.merge!(content: {})
+        target_node[:content] ||= {}
         schema = target_node[:schema]
         return if mime_list.empty? || schema.nil?
 
         mime_list.each do |mime_type|
           # TODO upgrade to have content-type specific schema
-          target_node[:content][mime_type] = { schema: schema }
+          (target_node[:content][mime_type] ||= {}).merge!(schema: schema)
         end
       end
 

From 1ff396fb5612f634de6e8d032fb381e1538cb000 Mon Sep 17 00:00:00 2001
From: Oleg Yakovenko <olegykz@gmail.com>
Date: Thu, 4 Jun 2020 17:17:30 +0300
Subject: [PATCH 05/61] example group helper adjustment

---
 rswag-specs/lib/rswag/specs/example_group_helpers.rb     | 9 ++++++++-
 .../spec/rswag/specs/example_group_helpers_spec.rb       | 9 +++++++--
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/example_group_helpers.rb b/rswag-specs/lib/rswag/specs/example_group_helpers.rb
index 591a7e9cd..6d32a958c 100644
--- a/rswag-specs/lib/rswag/specs/example_group_helpers.rb
+++ b/rswag-specs/lib/rswag/specs/example_group_helpers.rb
@@ -72,9 +72,16 @@ def header(name, attributes)
       def examples(example = nil)
         return super() if example.nil?
 
-        metadata[:response][:examples] = example
+        metadata[:response][:content] =
+          example.each_with_object({}) do |(mime, example_object), memo|
+            memo[mime] = { example: example_object }
+          end
       end
 
+      # example.metadata[:response][:content] = {
+      #   'application/json' => { example: json }
+      # }
+
       def run_test!(&block)
         # NOTE: rspec 2.x support
         if RSPEC_VERSION < 3
diff --git a/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb b/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb
index 29225230b..40bca7bcf 100644
--- a/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb
+++ b/rswag-specs/spec/rswag/specs/example_group_helpers_spec.rb
@@ -137,9 +137,10 @@ module Specs
       end
 
       describe '#examples(example)' do
+        let(:mime) { 'application/json' }
         let(:json_example) do
           {
-            'application/json' => {
+            mime => {
               foo: 'bar'
             }
           }
@@ -151,7 +152,11 @@ module Specs
         end
 
         it "adds to the 'response examples' metadata" do
-          expect(api_metadata[:response][:examples]).to eq(json_example)
+          expect(api_metadata[:response][:content]).to match(
+            mime => {
+              example: json_example[mime]
+            }
+          )
         end
       end
     end

From 81c110022ec618ff5dc400ce47a2aa67904f8947 Mon Sep 17 00:00:00 2001
From: Oleg Yakovenko <olegykz@gmail.com>
Date: Thu, 4 Jun 2020 17:19:15 +0300
Subject: [PATCH 06/61] example json actualized

---
 test-app/swagger/v1/swagger.json | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 957206cd9..874e8ab32 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -235,16 +235,14 @@
                 "type": "string"
               }
             },
-            "examples": {
-              "application/json": {
-                "id": 1,
-                "title": "Hello world!",
-                "content": "Hello world and hello universe. Thank you all very much!!!",
-                "thumbnail": "thumbnail.png"
-              }
-            },
             "content": {
               "application/json": {
+                "example": {
+                  "id": 1,
+                  "title": "Hello world!",
+                  "content": "Hello world and hello universe. Thank you all very much!!!",
+                  "thumbnail": "thumbnail.png"
+                },
                 "schema": {
                   "$ref": "#/definitions/blog"
                 }

From 7c3c35729117ba05ce7cf5966541be52959e601f Mon Sep 17 00:00:00 2001
From: Oleg Yakovenko <olegykz@gmail.com>
Date: Thu, 4 Jun 2020 17:22:20 +0300
Subject: [PATCH 07/61] cleanup

---
 rswag-specs/lib/rswag/specs/example_group_helpers.rb | 4 ----
 1 file changed, 4 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/example_group_helpers.rb b/rswag-specs/lib/rswag/specs/example_group_helpers.rb
index 6d32a958c..2a2cdec29 100644
--- a/rswag-specs/lib/rswag/specs/example_group_helpers.rb
+++ b/rswag-specs/lib/rswag/specs/example_group_helpers.rb
@@ -78,10 +78,6 @@ def examples(example = nil)
           end
       end
 
-      # example.metadata[:response][:content] = {
-      #   'application/json' => { example: json }
-      # }
-
       def run_test!(&block)
         # NOTE: rspec 2.x support
         if RSPEC_VERSION < 3

From f0fba9c093e1790b4692eccff865dfb619677c41 Mon Sep 17 00:00:00 2001
From: Andrew Kofink <akofink@redhat.com>
Date: Mon, 8 Jun 2020 11:53:03 -0400
Subject: [PATCH 08/61] Update wording in gemspecs to include OpenAPI

Fixes #333

Mentioning OpenAPI in the gemspec allows users on rubygems.org to find
this gem easily. Those who are still looking for Swagger tools will also
continue to find the gem, since I've mentioned that OpenAPI used to be
called Swagger.

Signed-off-by: Andrew Kofink <akofink@redhat.com>
---
 rswag-api/rswag-api.gemspec     | 4 ++--
 rswag-specs/rswag-specs.gemspec | 4 ++--
 rswag-ui/rswag-ui.gemspec       | 4 ++--
 rswag/rswag.gemspec             | 4 ++--
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/rswag-api/rswag-api.gemspec b/rswag-api/rswag-api.gemspec
index e19a24a16..850be0f35 100644
--- a/rswag-api/rswag-api.gemspec
+++ b/rswag-api/rswag-api.gemspec
@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Richie Morris', 'Greg Myers', 'Jay Danielian']
   s.email       = ['domaindrivendev@gmail.com']
   s.homepage    = 'https://github.com/rswag/rswag'
-  s.summary     = 'A Rails Engine that exposes Swagger files as JSON endpoints'
-  s.description = 'Open up your API to the phenomenal Swagger ecosystem by exposing Swagger files, that describe your service, as JSON endpoints'
+  s.summary     = 'A Rails Engine that exposes OpenAPI (formerly called Swagger) files as JSON endpoints'
+  s.description = 'Open up your API to the phenomenal OpenAPI ecosystem by exposing OpenAPI files, that describe your service, as JSON endpoints. More about the OpenAPI initiative here: http://spec.openapis.org/'
   s.license     = 'MIT'
 
   s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile']
diff --git a/rswag-specs/rswag-specs.gemspec b/rswag-specs/rswag-specs.gemspec
index 0f7dbc6fa..44f644b89 100644
--- a/rswag-specs/rswag-specs.gemspec
+++ b/rswag-specs/rswag-specs.gemspec
@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Richie Morris', 'Greg Myers', 'Jay Danielian']
   s.email       = ['domaindrivendev@gmail.com']
   s.homepage    = 'https://github.com/rswag/rswag'
-  s.summary     = 'A Swagger-based DSL for rspec-rails & accompanying rake task for generating Swagger files'
-  s.description = 'Simplify API integration testing with a succinct rspec DSL and generate Swagger files directly from your rspecs'
+  s.summary     = 'An OpenAPI-based (formerly called Swagger) DSL for rspec-rails & accompanying rake task for generating OpenAPI specification files'
+  s.description = 'Simplify API integration testing with a succinct rspec DSL and generate OpenAPI specification files directly from your rspecs. More about the OpenAPI initiative here: http://spec.openapis.org/'
   s.license     = 'MIT'
 
   s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile']
diff --git a/rswag-ui/rswag-ui.gemspec b/rswag-ui/rswag-ui.gemspec
index 97cf681b4..86436729e 100644
--- a/rswag-ui/rswag-ui.gemspec
+++ b/rswag-ui/rswag-ui.gemspec
@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Richie Morris', 'Greg Myers', 'Jay Danielian']
   s.email       = ['domaindrivendev@gmail.com']
   s.homepage    = 'https://github.com/rswag/rswag'
-  s.summary     = 'A Rails Engine that includes swagger-ui and powers it from configured Swagger endpoints'
-  s.description = 'Expose beautiful API documentation, powered by Swagger JSON endpoints, including a UI to explore and test operations'
+  s.summary     = 'A Rails Engine that includes swagger-ui and powers it from configured OpenAPI (formerly named Swagger) endpoints'
+  s.description = 'Expose beautiful API documentation, powered by Swagger JSON endpoints, including a UI to explore and test operations. More about the OpenAPI initiative here: http://spec.openapis.org/'
   s.license     = 'MIT'
 
   s.files = Dir.glob('{lib,node_modules}/**/*') + ['MIT-LICENSE', 'Rakefile' ]
diff --git a/rswag/rswag.gemspec b/rswag/rswag.gemspec
index edf341fe4..8a69f556a 100644
--- a/rswag/rswag.gemspec
+++ b/rswag/rswag.gemspec
@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors     = ['Richie Morris', 'Greg Myers', 'Jay Danielian']
   s.email       = ['domaindrivendev@gmail.com']
   s.homepage    = 'https://github.com/rswag/rswag'
-  s.summary     = 'Swagger tooling for Rails APIs'
-  s.description = 'Generate beautiful API documentation, including a UI to explore and test operations, directly from your rspec integration tests'
+  s.summary     = 'OpenAPI (formerly named Swagger) tooling for Rails APIs'
+  s.description = 'Generate beautiful API documentation, including a UI to explore and test operations, directly from your rspec integration tests. OpenAPI 2 and 3 supported. More about the OpenAPI initiative here: http://spec.openapis.org/'
   s.license     = 'MIT'
 
   s.files = Dir['{lib}/**/*'] + [ 'MIT-LICENSE' ]

From 30002e5b986d7386f9dbd2c1701f63cffdb8a4b3 Mon Sep 17 00:00:00 2001
From: Brennan Spellacy <brennanspellacy@gmail.com>
Date: Wed, 1 Jul 2020 20:08:32 -0700
Subject: [PATCH 09/61] Add required field

---
 rswag-specs/lib/rswag/specs/swagger_formatter.rb | 1 +
 test-app/swagger/v1/swagger.json                 | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 0b15f1236..69af77198 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -59,6 +59,7 @@ def stop(_notification = nil)
                   mime_list = value.dig(:consumes)
                   if value && schema_param && mime_list
                     value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
+                    value[:requestBody][:required] = true if schema_param[:required]
                     mime_list.each do |mime|
                       value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
                     end
diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 957206cd9..4c8afee8b 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -294,7 +294,8 @@
                 "type": "file"
               }
             }
-          }
+          },
+          "required": true
         }
       }
     }

From 347f9da32ef5897d23e0c21ab4e01411b7c3ef66 Mon Sep 17 00:00:00 2001
From: psmandzich <psmandzich@users.noreply.github.com>
Date: Tue, 21 Jul 2020 09:50:47 +0200
Subject: [PATCH 10/61] enable swagger empty body responses

---
 .../lib/rswag/specs/swagger_formatter.rb      |  2 +-
 .../rswag/specs/swagger_formatter_spec.rb     | 50 +++++++++++++++++++
 test-app/swagger/v1/swagger.json              | 40 ++++-----------
 3 files changed, 61 insertions(+), 31 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 0b15f1236..37ddd26a5 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -129,9 +129,9 @@ def upgrade_response_produces!(swagger_doc, metadata)
       end
 
       def upgrade_content!(mime_list, target_node)
-        target_node.merge!(content: {})
         schema = target_node[:schema]
         return if mime_list.empty? || schema.nil?
+        target_node.merge!(content: {})
 
         mime_list.each do |mime_type|
           # TODO upgrade to have content-type specific schema
diff --git a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
index 1a9fdf036..2ae0d057d 100644
--- a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
+++ b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
@@ -127,6 +127,56 @@ module Specs
             )
           end
 
+          context 'with empty content' do
+            let(:swagger_doc) do
+              {
+                openapi: '3.0.1',
+                basePath: '/foo',
+                schemes: ['http', 'https'],
+                host: 'api.example.com',
+                components: {
+                  securitySchemes: {
+                    myClientCredentials: {
+                      type: :oauth2,
+                      flow: :application,
+                      token_url: :somewhere
+                    },
+                    myAuthorizationCode: {
+                      type: :oauth2,
+                      flow: :accessCode,
+                      token_url: :somewhere
+                    },
+                    myImplicit: {
+                      type: :oauth2,
+                      flow: :implicit,
+                      token_url: :somewhere
+                    }
+                  }
+                }
+              }
+            end
+
+            it 'converts query and path params, type: to schema: { type: }' do
+              expect(swagger_doc.slice(:paths)).to match(
+                paths: {
+                  '/blogs' => {
+                    parameters: [{ schema: { type: :string } }],
+                    post: {
+                      parameters: [{ schema: { type: :string } }],
+                      summary: 'Creates a blog',
+                      responses: {
+                        '201' => {
+                          description: 'blog created',
+                          headers: { schema: { type: :string } }
+                        }
+                      }
+                    }
+                  }
+                }
+              )
+            end
+          end
+
           it 'converts basePath, schemas and host to urls' do
             expect(swagger_doc.slice(:servers)).to match(
               servers: {
diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 957206cd9..a5ea43b97 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -21,14 +21,10 @@
         ],
         "responses": {
           "204": {
-            "description": "Valid credentials",
-            "content": {
-            }
+            "description": "Valid credentials"
           },
           "401": {
-            "description": "Invalid credentials",
-            "content": {
-            }
+            "description": "Invalid credentials"
           }
         }
       }
@@ -49,14 +45,10 @@
         ],
         "responses": {
           "204": {
-            "description": "Valid credentials",
-            "content": {
-            }
+            "description": "Valid credentials"
           },
           "401": {
-            "description": "Invalid credentials",
-            "content": {
-            }
+            "description": "Invalid credentials"
           }
         }
       }
@@ -80,14 +72,10 @@
         ],
         "responses": {
           "204": {
-            "description": "Valid credentials",
-            "content": {
-            }
+            "description": "Valid credentials"
           },
           "401": {
-            "description": "Invalid credentials",
-            "content": {
-            }
+            "description": "Invalid credentials"
           }
         }
       }
@@ -105,9 +93,7 @@
         ],
         "responses": {
           "201": {
-            "description": "blog created",
-            "content": {
-            }
+            "description": "blog created"
           },
           "422": {
             "description": "invalid request",
@@ -148,9 +134,7 @@
         ],
         "responses": {
           "406": {
-            "description": "unsupported accept header",
-            "content": {
-            }
+            "description": "unsupported accept header"
           }
         }
       }
@@ -252,9 +236,7 @@
             }
           },
           "404": {
-            "description": "blog not found",
-            "content": {
-            }
+            "description": "blog not found"
           }
         }
       }
@@ -282,9 +264,7 @@
         ],
         "responses": {
           "200": {
-            "description": "blog updated",
-            "content": {
-            }
+            "description": "blog updated"
           }
         },
         "requestBody": {

From 423e86c4635187ff08e272378c5253513f397ab9 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:13:53 -0700
Subject: [PATCH 11/61] bump ruby-version, stricter npm lockfile

---
 .ruby-version              | 2 +-
 rswag-ui/package-lock.json | 6 ++++--
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/.ruby-version b/.ruby-version
index ec1cf33c3..37c2961c2 100644
--- a/.ruby-version
+++ b/.ruby-version
@@ -1 +1 @@
-2.6.3
+2.7.2
diff --git a/rswag-ui/package-lock.json b/rswag-ui/package-lock.json
index 461291aec..4c73fc0fa 100644
--- a/rswag-ui/package-lock.json
+++ b/rswag-ui/package-lock.json
@@ -1,11 +1,13 @@
 {
   "name": "rswag-ui",
   "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
   "dependencies": {
     "swagger-ui-dist": {
       "version": "3.28.0",
-      "from": "swagger-ui-dist@3.28.0",
-      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.28.0.tgz"
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.28.0.tgz",
+      "integrity": "sha512-aPkfTzPv9djSiZI1NUkWr5HynCUsH+jaJ0WSx+/t19wq7MMGg9clHm9nGoIpAtqml1G51ofI+I75Ym72pukzFg=="
     }
   }
 }

From ea89b0b0d56c4bde2080d08064951c76cef48716 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.macey@versapay.com>
Date: Mon, 12 Oct 2020 13:16:17 -0700
Subject: [PATCH 12/61] Github Actions CI

---
 .github/workflows/ruby.yml | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 .github/workflows/ruby.yml

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
new file mode 100644
index 000000000..cb7feb47e
--- /dev/null
+++ b/.github/workflows/ruby.yml
@@ -0,0 +1,32 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: ./ci/build.sh
+    - name: Run tests
+      run: ./ci/test.sh

From e4196352096be6e2c421db908088d1b2d2050b6a Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:20:46 -0700
Subject: [PATCH 13/61] cache gems/npm

---
 .github/workflows/ruby.yml | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index cb7feb47e..e782f184b 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -19,13 +19,17 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+    - uses: ruby/setup-ruby@v1
+      with: { ruby-version: 2.6 }
+
+    - uses: actions/cache@v2
+      id: cache
       with:
-        ruby-version: 2.6
+        path: |
+          rswag-ui/node_modules
+          vendor/bundle
+        key: ${{ runner.os }}-deps-${{ hashFiles('**/Gemfile.lock', '**/yarn.lock') }}
+
     - name: Install dependencies
       run: ./ci/build.sh
     - name: Run tests

From eb14eba7eb0c314cbc1144acdd36f5fef3620667 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:26:31 -0700
Subject: [PATCH 14/61] build individually

---
 .github/workflows/ruby.yml | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index e782f184b..03a5c62f5 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -31,6 +31,27 @@ jobs:
         key: ${{ runner.os }}-deps-${{ hashFiles('**/Gemfile.lock', '**/yarn.lock') }}
 
     - name: Install dependencies
-      run: ./ci/build.sh
-    - name: Run tests
-      run: ./ci/test.sh
+      run: |
+        bundle install
+        cd rswag-ui && npm install
+
+    - name: rswag-api
+      run: |
+        cd rswag-api
+        bundle exec rspec
+
+    - name: rswag-specs
+      run: |
+        cd rswag-specs
+        bundle exec rspec
+
+    - name: rswag-ui
+      run: |
+        cd rswag-ui
+        bundle exec rspec
+
+    - name: test-app
+      run: |
+        cd test-app
+        bundle exec rake db:migrate db:test:prepare
+        bundle exec rspec

From 27b015b3d268d60b0f80c53041d566b0cfe8a389 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:29:28 -0700
Subject: [PATCH 15/61] ensure we run all specs if there are early failures

---
 .github/workflows/ruby.yml | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index 03a5c62f5..46548e3ed 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -41,16 +41,19 @@ jobs:
         bundle exec rspec
 
     - name: rswag-specs
+      if: succeeded() || failed()
       run: |
         cd rswag-specs
         bundle exec rspec
 
     - name: rswag-ui
+      if: succeeded() || failed()
       run: |
         cd rswag-ui
         bundle exec rspec
 
     - name: test-app
+      if: succeeded() || failed()
       run: |
         cd test-app
         bundle exec rake db:migrate db:test:prepare

From 08b1678e53126d4cd78059f0bd28571e9fb59019 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:37:57 -0700
Subject: [PATCH 16/61] skip a test requiring headless firefox capybara driver

---
 test-app/spec/features/swagger_ui_spec.rb | 1 +
 1 file changed, 1 insertion(+)

diff --git a/test-app/spec/features/swagger_ui_spec.rb b/test-app/spec/features/swagger_ui_spec.rb
index 484ad657a..7c86110a1 100644
--- a/test-app/spec/features/swagger_ui_spec.rb
+++ b/test-app/spec/features/swagger_ui_spec.rb
@@ -3,6 +3,7 @@
 RSpec.feature 'swagger-ui', js: true do
 
   scenario 'browsing api-docs' do
+    skip "Needs work to run on others' machines"
     visit '/api-docs'
 
     expect(page).to have_content('GET /blogs Searches blogs', normalize_ws: true)

From 4c06f95a683dde8d988dbdf5b4e1fa7536a7dd1d Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:43:58 -0700
Subject: [PATCH 17/61] run multiple ruby/rails versions

---
 .github/workflows/ruby.yml | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index 46548e3ed..a5df5a672 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -16,6 +16,11 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      ruby: [2.6, 2.7]
+      rails: [5.2.4.4, 6.0.3.4]
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
 
     steps:
     - uses: actions/checkout@v2
@@ -28,7 +33,7 @@ jobs:
         path: |
           rswag-ui/node_modules
           vendor/bundle
-        key: ${{ runner.os }}-deps-${{ hashFiles('**/Gemfile.lock', '**/yarn.lock') }}
+        key: ${{ runner.os }}-ruby-${{ matrix.ruby }}-rails-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock', '**/yarn.lock') }}
 
     - name: Install dependencies
       run: |

From 04059808d57e1e718dc62f74b4fdf8138a081326 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:45:38 -0700
Subject: [PATCH 18/61] fix matrix syntax

---
 .github/workflows/ruby.yml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index a5df5a672..01c5a45e8 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -17,8 +17,9 @@ jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
-      ruby: [2.6, 2.7]
-      rails: [5.2.4.4, 6.0.3.4]
+      matrix:
+        ruby: [2.6, 2.7]
+        rails: [5.2.4.4, 6.0.3.4]
     env:
       RAILS_VERSION: ${{ matrix.rails }}
 

From 1cd7df89f10a59355c6e6a23800a6313e58af7ce Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:47:36 -0700
Subject: [PATCH 19/61] update conditional tags

---
 .github/workflows/ruby.yml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index 01c5a45e8..9e3c97356 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -47,19 +47,19 @@ jobs:
         bundle exec rspec
 
     - name: rswag-specs
-      if: succeeded() || failed()
+      if: success() || failure()
       run: |
         cd rswag-specs
         bundle exec rspec
 
     - name: rswag-ui
-      if: succeeded() || failed()
+      if: success() || failure()
       run: |
         cd rswag-ui
         bundle exec rspec
 
     - name: test-app
-      if: succeeded() || failed()
+      if: success() || failure()
       run: |
         cd test-app
         bundle exec rake db:migrate db:test:prepare

From 38c861f5e0d09cf3db96698c3b8baf1902e562eb Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:51:42 -0700
Subject: [PATCH 20/61] strip prelude

---
 .github/workflows/ruby.yml | 7 -------
 1 file changed, 7 deletions(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index 9e3c97356..5e4fc0358 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -1,10 +1,3 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
 name: Ruby
 
 on:

From c990348f0b915df1e8e12960c7b19faca744a132 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 13:56:22 -0700
Subject: [PATCH 21/61] update cache hash

---
 .github/workflows/ruby.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index 5e4fc0358..fd15653a6 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -27,7 +27,7 @@ jobs:
         path: |
           rswag-ui/node_modules
           vendor/bundle
-        key: ${{ runner.os }}-ruby-${{ matrix.ruby }}-rails-${{ matrix.rails }}-${{ hashFiles('**/Gemfile.lock', '**/yarn.lock') }}
+        key: ${{ runner.os }}-ruby_${{ matrix.ruby }}-rails_${{ matrix.rails }}-${{ hashFiles('Gemfile', '**/package-lock.json') }}
 
     - name: Install dependencies
       run: |

From 0a9487b3284a01efba2f658b568c7c73f362b6b8 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Tue, 13 Oct 2020 10:14:02 -0700
Subject: [PATCH 22/61] make spec output less noisy

---
 rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb | 2 ++
 test-app/spec/integration/auth_tests_spec.rb           | 4 ++++
 test-app/spec/integration/blogs_spec.rb                | 4 ++++
 3 files changed, 10 insertions(+)

diff --git a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
index 1a9fdf036..0109f6777 100644
--- a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
+++ b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
@@ -11,6 +11,8 @@ module Specs
       # Mock out some infrastructure
       before do
         allow(config).to receive(:swagger_root).and_return(swagger_root)
+
+        allow(ActiveSupport::Deprecation).to receive(:warn) # Silence deprecation output from specs
       end
       let(:config) { double('config') }
       let(:output) { double('output').as_null_object }
diff --git a/test-app/spec/integration/auth_tests_spec.rb b/test-app/spec/integration/auth_tests_spec.rb
index 58e4180e1..926dcba87 100644
--- a/test-app/spec/integration/auth_tests_spec.rb
+++ b/test-app/spec/integration/auth_tests_spec.rb
@@ -3,6 +3,10 @@
 require 'swagger_helper'
 
 RSpec.describe 'Auth Tests API', type: :request, swagger_doc: 'v1/swagger.json' do
+  before do
+    allow(ActiveSupport::Deprecation).to receive(:warn) # Silence deprecation output from specs
+  end
+
   path '/auth-tests/basic' do
     post 'Authenticates with basic auth' do
       tags 'Auth Tests'
diff --git a/test-app/spec/integration/blogs_spec.rb b/test-app/spec/integration/blogs_spec.rb
index ee4a67ef9..bfe67b697 100644
--- a/test-app/spec/integration/blogs_spec.rb
+++ b/test-app/spec/integration/blogs_spec.rb
@@ -3,6 +3,10 @@
 RSpec.describe 'Blogs API', type: :request, swagger_doc: 'v1/swagger.json' do
   let(:api_key) { 'fake_key' }
 
+  before do
+    allow(ActiveSupport::Deprecation).to receive(:warn) # Silence deprecation output from specs
+  end
+
   path '/blogs' do
     post 'Creates a blog' do
       tags 'Blogs'

From b37c7905cd0154042aa39a8b94ba570a445ea694 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 22:47:31 -0700
Subject: [PATCH 23/61] stub controller to help with future testing

---
 test-app/app/assets/javascripts/stubs.js     | 2 ++
 test-app/app/assets/stylesheets/stubs.css    | 4 ++++
 test-app/app/controllers/stubs_controller.rb | 9 +++++++++
 test-app/app/helpers/stubs_helper.rb         | 2 ++
 test-app/config/routes.rb                    | 2 ++
 5 files changed, 19 insertions(+)
 create mode 100644 test-app/app/assets/javascripts/stubs.js
 create mode 100644 test-app/app/assets/stylesheets/stubs.css
 create mode 100644 test-app/app/controllers/stubs_controller.rb
 create mode 100644 test-app/app/helpers/stubs_helper.rb

diff --git a/test-app/app/assets/javascripts/stubs.js b/test-app/app/assets/javascripts/stubs.js
new file mode 100644
index 000000000..dee720fac
--- /dev/null
+++ b/test-app/app/assets/javascripts/stubs.js
@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
diff --git a/test-app/app/assets/stylesheets/stubs.css b/test-app/app/assets/stylesheets/stubs.css
new file mode 100644
index 000000000..afad32db0
--- /dev/null
+++ b/test-app/app/assets/stylesheets/stubs.css
@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
diff --git a/test-app/app/controllers/stubs_controller.rb b/test-app/app/controllers/stubs_controller.rb
new file mode 100644
index 000000000..7a4acd9ef
--- /dev/null
+++ b/test-app/app/controllers/stubs_controller.rb
@@ -0,0 +1,9 @@
+class StubsController < ApplicationController
+  def index
+    render plain: 'OK'
+  end
+
+  def show
+    render plain: 'OK'
+  end
+end
diff --git a/test-app/app/helpers/stubs_helper.rb b/test-app/app/helpers/stubs_helper.rb
new file mode 100644
index 000000000..7ae90345d
--- /dev/null
+++ b/test-app/app/helpers/stubs_helper.rb
@@ -0,0 +1,2 @@
+module StubsHelper
+end
diff --git a/test-app/config/routes.rb b/test-app/config/routes.rb
index 038f728eb..3107e95a7 100644
--- a/test-app/config/routes.rb
+++ b/test-app/config/routes.rb
@@ -9,6 +9,8 @@
   post 'auth-tests/api-key', to: 'auth_tests#api_key'
   post 'auth-tests/basic-and-api-key', to: 'auth_tests#basic_and_api_key'
 
+  resources :stubs
+
   mount  Rswag::Api::Engine => 'api-docs'
   mount  Rswag::Ui::Engine => 'api-docs'
 end

From 7e1a79220cf6c33adc6e295e0e0d8005c9aa7996 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 22:49:47 -0700
Subject: [PATCH 24/61] start standing up exhaustive output unit tests for
 OpenAPI v3

---
 test-app/spec/integration/openapi3_spec.rb | 273 +++++++++++++++++++++
 test-app/spec/swagger_helper.rb            |  63 +++++
 test-app/swagger/v3/openapi.json           | 139 +++++++++++
 3 files changed, 475 insertions(+)
 create mode 100644 test-app/spec/integration/openapi3_spec.rb
 create mode 100644 test-app/swagger/v3/openapi.json

diff --git a/test-app/spec/integration/openapi3_spec.rb b/test-app/spec/integration/openapi3_spec.rb
new file mode 100644
index 000000000..8d0d082fd
--- /dev/null
+++ b/test-app/spec/integration/openapi3_spec.rb
@@ -0,0 +1,273 @@
+require 'swagger_helper'
+require 'rswag/specs/swagger_formatter'
+
+# This spec file validates OpenAPI output generated by spec metadata.
+# Specifically here, we look at OpenApi 3 as documented at
+# https://swagger.io/docs/specification/about/
+
+RSpec.describe 'Generated OpenApi', type: :request, swagger_doc: 'v3/openapi.json' do
+  before do |example|
+    output = double('output').as_null_object
+    swagger_root = File.expand_path('tmp/swagger', __dir__)
+    config = double('config', swagger_root: swagger_root, get_swagger_doc: swagger_doc )
+    formatter = Rswag::Specs::SwaggerFormatter.new(output, config)
+    
+    example_group = OpenStruct.new(group: OpenStruct.new(metadata: example.metadata))
+    formatter.example_group_finished(example_group)
+  end
+
+  # Framework definition, to be overridden for contexts
+  let(:swagger_doc) do
+    { # That which would be defined in swagger_helper.rb
+      openapi: api_openapi,
+      basePath: api_base_path,
+      schemes: api_schemes,
+      host: api_host,
+      produces: api_produces,
+      components: api_components
+    }
+  end
+  let(:api_openapi) { '3.0.1' }
+  let(:api_base_path) { '/foo' }
+  let(:api_schemes) { ['https'] }
+  let(:api_host) { 'api.example.com' }
+  let(:api_produces) { ['application/json'] }
+  let(:api_components) { {} }
+
+  describe 'Basic Structure'
+  describe 'API Server and Base Path'
+
+  describe 'Media Types' do
+    path '/stubs' do
+      get 'a summary' do
+        tags 'Media Types'
+
+        response '200', 'OK' do
+          run_test!
+
+          it 'declares output as application/json' do
+            pending "Not yet implemented?"
+            tree = swagger_doc.dig(:paths, "/stubs", :get, :responses, '200', :content)
+            expect(tree).to have_key('application/json')
+          end
+        end
+      end
+    end
+  end
+
+  describe 'Paths and Operations'
+
+  describe 'Parameter Serialization' do
+    describe 'Path Parameters' do
+      path '/stubs/{a_param}' do
+        get 'a summary' do
+          tags 'Parameter Serialization: Query String'
+          produces 'application/json'
+
+          parameter(
+            name: 'a_param',
+            in: :path,
+          )
+          let(:a_param) { "42" }
+
+          response '200', 'OK' do
+            run_test!
+
+            it 'declares parameter in path' do
+              tree = swagger_doc.dig(:paths, "/stubs/{a_param}", :get, :parameters)
+              expect(tree.first[:name]).to eq('a_param')
+              expect(tree.first[:in]).to eq(:path)
+            end
+
+            it 'declares path parameters as required' do
+              tree = swagger_doc.dig(:paths, "/stubs/{a_param}", :get, :parameters)
+              expect(tree.first[:required]).to eq(true)
+            end
+          end
+        end
+      end
+    end
+
+    describe 'Query Parameters' do
+      path '/stubs' do
+        get 'a summary' do
+          tags 'Parameter Serialization: Query String'
+          produces 'application/json'
+
+          parameter(
+            name: 'a_param',
+            in: :query,
+          )
+          let(:a_param) { "a foo" }
+
+          response '200', 'OK' do
+            run_test!
+
+            it 'declares parameter in query string' do
+              tree = swagger_doc.dig(:paths, "/stubs", :get, :parameters)
+              expect(tree.first[:name]).to eq('a_param')
+              expect(tree.first[:in]).to eq(:query)
+            end
+          end
+
+          # TODO: Serialization (form/spaceDelimited/pipeDelimited/deepObject)
+        end
+      end
+    end
+
+    # TODO: Header
+    # TODO: Cookie
+    # TODO: Default values
+    # TODO: Enum
+    # TODO: Constant
+    # TODO: Empty/Nullable
+    # TODO: Examples
+    # TODO: Deprecated
+    # TODO: Common Parameters
+  end
+
+  describe 'Request Body'
+  describe 'Responses'
+  describe 'Data Models (Schemas)'
+  describe 'Examples'
+  describe 'Authentication'
+  describe 'Links'
+  describe 'Callbacks'
+  describe 'Components Section'
+  describe 'Using $ref'
+  describe 'Grouping Operations with Tags'
+
+
+  # path '/blogs' do
+  #   post 'Creates a blog' do
+  #     tags 'Blogs'
+  #     description 'Creates a new blog from provided data'
+  #     operationId 'createBlog'
+  #     consumes 'application/json'
+  #     produces 'application/json'
+  #     parameter name: :blog, in: :body, schema: { '$ref' => '#/definitions/blog' }
+
+  #     let(:blog) { { title: 'foo', content: 'bar' } }
+
+  #     response '201', 'blog created' do
+  #       # schema '$ref' => '#/definitions/blog'
+  #       run_test!
+  #     end
+
+  #     response '422', 'invalid request' do
+  #       schema '$ref' => '#/definitions/errors_object'
+
+  #       let(:blog) { { title: 'foo' } }
+  #       run_test! do |response|
+  #         expect(response.body).to include("can't be blank")
+  #       end
+
+  #       it 'outputs parameters' do
+  #         pp swagger_doc
+  #         params = swagger_doc.dig(:paths, "/blogs", :post, :parameters)
+  #         expect(params[0][:name]).to eq(:blog)
+  #       end
+  #     end
+  #   end
+
+  #   get 'Searches blogs' do
+  #     tags 'Blogs'
+  #     description 'Searches blogs by keywords'
+  #     operationId 'searchBlogs'
+  #     produces 'application/json'
+  #     parameter name: :keywords, in: :query, type: 'string'
+
+  #     let(:keywords) { 'foo bar' }
+
+  #     response '200', 'success' do
+  #       schema type: 'array', items: { '$ref' => '#/definitions/blog' }
+  #     end
+
+  #     response '406', 'unsupported accept header' do
+  #       let(:'Accept') { 'application/foo' }
+  #       run_test!
+  #     end
+  #   end
+  # end
+
+  # path '/blogs/flexible' do
+  #   post 'Creates a blog flexible body' do
+  #     tags 'Blogs'
+  #     description 'Creates a flexible blog from provided data'
+  #     operationId 'createFlexibleBlog'
+  #     consumes 'application/json'
+  #     produces 'application/json'
+
+  #     parameter name: :flexible_blog, in: :body, schema: {
+  #       oneOf: [
+  #         { '$ref' => '#/definitions/blog' },
+  #         { '$ref' => '#/definitions/flexible_blog' }
+  #       ]
+  #     }
+
+  #     let(:flexible_blog) { { blog: { headline: 'my headline', text: 'my text' } } }
+
+  #     response '201', 'flexible blog created' do
+  #       schema oneOf: [{ '$ref' => '#/definitions/blog' }, { '$ref' => '#/definitions/flexible_blog' }]
+  #       run_test!
+  #     end
+  #   end
+  # end
+
+  # path '/blogs/{id}' do
+  #   parameter name: :id, in: :path, type: :string
+
+  #   let(:id) { blog.id }
+  #   let(:blog) { Blog.create(title: 'foo', content: 'bar', thumbnail: 'thumbnail.png') }
+
+  #   get 'Retrieves a blog' do
+  #     tags 'Blogs'
+  #     description 'Retrieves a specific blog by id'
+  #     operationId 'getBlog'
+  #     produces 'application/json'
+
+  #     response '200', 'blog found' do
+  #       header 'ETag', type: :string
+  #       header 'Last-Modified', type: :string
+  #       header 'Cache-Control', type: :string
+
+  #       schema '$ref' => '#/definitions/blog'
+
+  #       examples 'application/json' => {
+  #         id: 1,
+  #         title: 'Hello world!',
+  #         content: 'Hello world and hello universe. Thank you all very much!!!',
+  #         thumbnail: 'thumbnail.png'
+  #       }
+
+  #       let(:id) { blog.id }
+  #       run_test!
+  #     end
+
+  #     response '404', 'blog not found' do
+  #       let(:id) { 'invalid' }
+  #       run_test!
+  #     end
+  #   end
+  # end
+
+  # path '/blogs/{id}/upload' do
+  #   parameter name: :id, in: :path, type: :string
+
+  #   let(:id) { blog.id }
+  #   let(:blog) { Blog.create(title: 'foo', content: 'bar') }
+
+  #   put 'Uploads a blog thumbnail' do
+  #     tags 'Blogs'
+  #     description 'Upload a thumbnail for specific blog by id'
+  #     operationId 'uploadThumbnailBlog'
+  #     consumes 'multipart/form-data'
+  #     parameter name: :file, :in => :formData, :type => :file, required: true
+
+  #     response '200', 'blog updated' do
+  #       let(:file) { Rack::Test::UploadedFile.new(Rails.root.join("spec/fixtures/thumbnail.png")) }
+  #       run_test!
+  #     end
+  #   end
+  # end
+end
diff --git a/test-app/spec/swagger_helper.rb b/test-app/spec/swagger_helper.rb
index 3f2e15131..3b8dfae39 100644
--- a/test-app/spec/swagger_helper.rb
+++ b/test-app/spec/swagger_helper.rb
@@ -77,6 +77,69 @@
           in: :query
         }
       }
+    },
+    'v3/openapi.json' => {
+      openapi: '3.0.0',
+      info: {
+        title: 'API V1',
+        version: 'v1'
+      },
+      paths: {},
+      servers: [
+        {
+          url: 'https://{defaultHost}',
+          variables: {
+            defaultHost: {
+              default: 'www.example.com'
+            }
+          }
+        }
+      ],
+      definitions: {
+        errors_object: {
+          type: 'object',
+          properties: {
+            errors: { '$ref' => '#/definitions/errors_map' }
+          }
+        },
+        errors_map: {
+          type: 'object',
+          additionalProperties: {
+            type: 'array',
+            items: { type: 'string' }
+          }
+        },
+        blog: {
+          type: 'object',
+          properties: {
+            id: { type: 'integer' },
+            title: { type: 'string' },
+            content: { type: 'string', 'x-nullable': true },
+            thumbnail: { type: 'string', 'x-nullable': true}
+          },
+          required: [ 'id', 'title' ]
+        },
+        flexible_blog: {
+          type: 'object',
+          properties: {
+            id: { type: 'integer' },
+            headline: { type: 'string' },
+            text: { type: 'string', nullable: true },
+            thumbnail: { type: 'string', nullable: true }
+          },
+          required: ['id', 'headline']
+        }
+      },
+      securityDefinitions: {
+        basic_auth: {
+          type: :basic
+        },
+        api_key: {
+          type: :apiKey,
+          name: 'api_key',
+          in: :query
+        }
+      }
     }
   }
 end
diff --git a/test-app/swagger/v3/openapi.json b/test-app/swagger/v3/openapi.json
new file mode 100644
index 000000000..97506c47e
--- /dev/null
+++ b/test-app/swagger/v3/openapi.json
@@ -0,0 +1,139 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "API V1",
+    "version": "v1"
+  },
+  "paths": {
+    "/stubs": {
+      "get": {
+        "summary": "a summary",
+        "tags": [
+          "Parameter Serialization: Query String"
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "a_param",
+            "in": "query"
+          }
+        ]
+      }
+    },
+    "/stubs/{a_param}": {
+      "get": {
+        "summary": "a summary",
+        "tags": [
+          "Parameter Serialization: Query String"
+        ],
+        "parameters": [
+          {
+            "name": "a_param",
+            "in": "path",
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+            }
+          }
+        }
+      }
+    }
+  },
+  "servers": [
+    {
+      "url": "https://{defaultHost}",
+      "variables": {
+        "defaultHost": {
+          "default": "www.example.com"
+        }
+      }
+    }
+  ],
+  "definitions": {
+    "errors_object": {
+      "type": "object",
+      "properties": {
+        "errors": {
+          "$ref": "#/definitions/errors_map"
+        }
+      }
+    },
+    "errors_map": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "array",
+        "items": {
+          "type": "string"
+        }
+      }
+    },
+    "blog": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer"
+        },
+        "title": {
+          "type": "string"
+        },
+        "content": {
+          "type": "string",
+          "x-nullable": true
+        },
+        "thumbnail": {
+          "type": "string",
+          "x-nullable": true
+        }
+      },
+      "required": [
+        "id",
+        "title"
+      ]
+    },
+    "flexible_blog": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "integer"
+        },
+        "headline": {
+          "type": "string"
+        },
+        "text": {
+          "type": "string",
+          "nullable": true
+        },
+        "thumbnail": {
+          "type": "string",
+          "nullable": true
+        }
+      },
+      "required": [
+        "id",
+        "headline"
+      ]
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "basic_auth": {
+        "type": "basic"
+      },
+      "api_key": {
+        "type": "apiKey",
+        "name": "api_key",
+        "in": "query"
+      }
+    }
+  }
+}
\ No newline at end of file

From f6630cc7a612f72839aa8d0257e3263992eb657e Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 22:50:48 -0700
Subject: [PATCH 25/61] fix a bug related to upgrade_request_type! translation

---
 rswag-specs/lib/rswag/specs/request_factory.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index 2e8f3f1da..30c423ef2 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -118,7 +118,7 @@ def add_path(request, metadata, swagger_doc, parameters, example)
 
       def build_query_string_part(param, value)
         name = param[:name]
-        return "#{name}=#{value}" unless param[:type].to_sym == :array
+        return "#{name}=#{value}" unless param.dig(:schema, :type)&.to_sym == :array
 
         case param[:collectionFormat]
         when :ssv

From 68e64dba2c563f5c7a1357c0cf7a0aa87860dfd1 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Mon, 12 Oct 2020 22:53:18 -0700
Subject: [PATCH 26/61] OpenAPI currently at v 3.0.3

---
 test-app/spec/integration/openapi3_spec.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/test-app/spec/integration/openapi3_spec.rb b/test-app/spec/integration/openapi3_spec.rb
index 8d0d082fd..7515ef1c1 100644
--- a/test-app/spec/integration/openapi3_spec.rb
+++ b/test-app/spec/integration/openapi3_spec.rb
@@ -27,7 +27,7 @@
       components: api_components
     }
   end
-  let(:api_openapi) { '3.0.1' }
+  let(:api_openapi) { '3.0.3' }
   let(:api_base_path) { '/foo' }
   let(:api_schemes) { ['https'] }
   let(:api_host) { 'api.example.com' }

From 91a27852f2f4786b4db5bbcf5d89f67158439be5 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Tue, 13 Oct 2020 09:17:15 -0700
Subject: [PATCH 27/61] more flex in this check

---
 rswag-specs/lib/rswag/specs/request_factory.rb | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index 30c423ef2..523b50f08 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -118,7 +118,8 @@ def add_path(request, metadata, swagger_doc, parameters, example)
 
       def build_query_string_part(param, value)
         name = param[:name]
-        return "#{name}=#{value}" unless param.dig(:schema, :type)&.to_sym == :array
+        type = param[:type] || param.dig(:schema, :type)
+        return "#{name}=#{value}" unless type&.to_sym == :array
 
         case param[:collectionFormat]
         when :ssv

From d090516f481dc5ee4037b51294adedbaac861621 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Tue, 13 Oct 2020 16:24:51 -0700
Subject: [PATCH 28/61] properly list servers for openapi v3

---
 test-app/spec/integration/openapi3_spec.rb | 69 +++++++++++++++++++---
 1 file changed, 62 insertions(+), 7 deletions(-)

diff --git a/test-app/spec/integration/openapi3_spec.rb b/test-app/spec/integration/openapi3_spec.rb
index 7515ef1c1..051c4640e 100644
--- a/test-app/spec/integration/openapi3_spec.rb
+++ b/test-app/spec/integration/openapi3_spec.rb
@@ -20,22 +20,77 @@
   let(:swagger_doc) do
     { # That which would be defined in swagger_helper.rb
       openapi: api_openapi,
-      basePath: api_base_path,
-      schemes: api_schemes,
-      host: api_host,
+      info: {},
+      servers: api_servers,
       produces: api_produces,
       components: api_components
     }
   end
   let(:api_openapi) { '3.0.3' }
-  let(:api_base_path) { '/foo' }
-  let(:api_schemes) { ['https'] }
-  let(:api_host) { 'api.example.com' }
+  let(:api_servers) {[{ url: "https://api.example.com/foo" }]}
   let(:api_produces) { ['application/json'] }
   let(:api_components) { {} }
 
   describe 'Basic Structure'
-  describe 'API Server and Base Path'
+
+  describe 'API Server and Base Path' do
+    path '/stubs' do
+      get 'a summary' do
+        tags 'Server and Path'
+
+        response '200', 'OK' do
+          run_test!
+
+          it 'lists server' do
+            tree = swagger_doc.dig(:servers)
+            expect(tree).to eq([
+              { url: "https://api.example.com/foo" }
+            ])
+          end
+
+          context "multiple" do
+            let(:api_servers) {[
+              { url: "https://api.example.com/foo" },
+              { url: "http://api.example.com/foo" },
+            ]}
+
+            it 'lists servers' do
+              tree = swagger_doc.dig(:servers)
+              expect(tree).to eq([
+                { url: "https://api.example.com/foo" },
+                { url: "http://api.example.com/foo" }
+              ])
+            end
+          end
+
+          context "with variables" do
+            let(:api_servers) {[{
+              url: "https://{defaultHost}/foo",
+              variables: {
+                defaultHost: {
+                  default: "api.example.com" 
+                }
+              }
+            }]}
+
+            it 'lists server and variables' do
+              tree = swagger_doc.dig(:servers)
+              expect(tree).to eq([{
+                url: "https://{defaultHost}/foo",
+                variables: {
+                  defaultHost: {
+                    default: "api.example.com" 
+                  }
+                }
+              }])
+            end
+          end
+
+          # TODO: Enum variables, defaults, override at path/operation
+        end
+      end
+    end
+  end
 
   describe 'Media Types' do
     path '/stubs' do

From 3e10b09f23b5ee63b765b2487b474952a984e495 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Tue, 13 Oct 2020 16:27:32 -0700
Subject: [PATCH 29/61] swap deprecated SecurityDefinitions for SecuritySchemes

---
 test-app/spec/swagger_helper.rb | 36 ++++++++++++++++++---------------
 1 file changed, 20 insertions(+), 16 deletions(-)

diff --git a/test-app/spec/swagger_helper.rb b/test-app/spec/swagger_helper.rb
index 3b8dfae39..ea72c4d33 100644
--- a/test-app/spec/swagger_helper.rb
+++ b/test-app/spec/swagger_helper.rb
@@ -67,14 +67,16 @@
           required: ['id', 'headline']
         }
       },
-      securityDefinitions: {
-        basic_auth: {
-          type: :basic
-        },
-        api_key: {
-          type: :apiKey,
-          name: 'api_key',
-          in: :query
+      components: {
+        securitySchemes: {
+          basic_auth: {
+            type: :basic
+          },
+          api_key: {
+            type: :apiKey,
+            name: 'api_key',
+            in: :query
+          }
         }
       }
     },
@@ -130,14 +132,16 @@
           required: ['id', 'headline']
         }
       },
-      securityDefinitions: {
-        basic_auth: {
-          type: :basic
-        },
-        api_key: {
-          type: :apiKey,
-          name: 'api_key',
-          in: :query
+      components: {
+        securitySchemes: {
+          basic_auth: {
+            type: :basic
+          },
+          api_key: {
+            type: :apiKey,
+            name: 'api_key',
+            in: :query
+          }
         }
       }
     }

From ab457743a820d0544fd464f86a0920ba13a224e0 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Tue, 13 Oct 2020 16:28:40 -0700
Subject: [PATCH 30/61] also move away from deprecated type: basic

---
 test-app/spec/swagger_helper.rb  | 6 ++++--
 test-app/swagger/v1/swagger.json | 3 ++-
 test-app/swagger/v3/openapi.json | 3 ++-
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/test-app/spec/swagger_helper.rb b/test-app/spec/swagger_helper.rb
index ea72c4d33..cadb59276 100644
--- a/test-app/spec/swagger_helper.rb
+++ b/test-app/spec/swagger_helper.rb
@@ -70,7 +70,8 @@
       components: {
         securitySchemes: {
           basic_auth: {
-            type: :basic
+            type: :http,
+            scheme: :basic
           },
           api_key: {
             type: :apiKey,
@@ -135,7 +136,8 @@
       components: {
         securitySchemes: {
           basic_auth: {
-            type: :basic
+            type: :http,
+            scheme: :basic
           },
           api_key: {
             type: :apiKey,
diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 957206cd9..e18f579b5 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -377,7 +377,8 @@
   "components": {
     "securitySchemes": {
       "basic_auth": {
-        "type": "basic"
+        "type": "http",
+        "scheme": "basic"
       },
       "api_key": {
         "type": "apiKey",
diff --git a/test-app/swagger/v3/openapi.json b/test-app/swagger/v3/openapi.json
index 97506c47e..90b9f18b4 100644
--- a/test-app/swagger/v3/openapi.json
+++ b/test-app/swagger/v3/openapi.json
@@ -127,7 +127,8 @@
   "components": {
     "securitySchemes": {
       "basic_auth": {
-        "type": "basic"
+        "type": "http",
+        "scheme": "basic"
       },
       "api_key": {
         "type": "apiKey",

From 0d1a742f6f3b65344946b6b6de49e25d38b89c82 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Sat, 17 Oct 2020 13:44:04 -0700
Subject: [PATCH 31/61] empty content is now pruned

---
 test-app/swagger/v3/openapi.json | 8 ++------
 1 file changed, 2 insertions(+), 6 deletions(-)

diff --git a/test-app/swagger/v3/openapi.json b/test-app/swagger/v3/openapi.json
index 90b9f18b4..a344f69fc 100644
--- a/test-app/swagger/v3/openapi.json
+++ b/test-app/swagger/v3/openapi.json
@@ -13,9 +13,7 @@
         ],
         "responses": {
           "200": {
-            "description": "OK",
-            "content": {
-            }
+            "description": "OK"
           }
         },
         "parameters": [
@@ -41,9 +39,7 @@
         ],
         "responses": {
           "200": {
-            "description": "OK",
-            "content": {
-            }
+            "description": "OK"
           }
         }
       }

From 5a60dee838d6d8fe9543a6ed01dd2156e8299282 Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Sat, 17 Oct 2020 14:15:41 -0700
Subject: [PATCH 32/61] Add a spec for #342 body/required

---
 test-app/app/controllers/stubs_controller.rb |  4 ++++
 test-app/spec/integration/openapi3_spec.rb   | 23 ++++++++++++++++++-
 test-app/swagger/v3/openapi.json             | 24 ++++++++++++++++++++
 3 files changed, 50 insertions(+), 1 deletion(-)

diff --git a/test-app/app/controllers/stubs_controller.rb b/test-app/app/controllers/stubs_controller.rb
index 7a4acd9ef..8b8ec8f00 100644
--- a/test-app/app/controllers/stubs_controller.rb
+++ b/test-app/app/controllers/stubs_controller.rb
@@ -3,6 +3,10 @@ def index
     render plain: 'OK'
   end
 
+  def create
+    render plain: 'OK'
+  end
+
   def show
     render plain: 'OK'
   end
diff --git a/test-app/spec/integration/openapi3_spec.rb b/test-app/spec/integration/openapi3_spec.rb
index 051c4640e..d3e5b5f8c 100644
--- a/test-app/spec/integration/openapi3_spec.rb
+++ b/test-app/spec/integration/openapi3_spec.rb
@@ -181,7 +181,28 @@
     # TODO: Common Parameters
   end
 
-  describe 'Request Body'
+  describe 'Request Body' do
+    path '/stubs' do
+      post 'body is required' do
+        tags 'Media Types'
+        consumes 'multipart/form-data'
+        parameter name: :file, :in => :formData, :type => :file, required: true
+
+        let(:file) { Rack::Test::UploadedFile.new(Rails.root.join("spec/fixtures/thumbnail.png")) }
+
+        response '200', 'OK' do
+          run_test!
+
+          it 'declares requestBody is required' do
+            pending "This output is massaged in SwaggerFormatter#stop, and isn't quite ready here to assert"
+            tree = swagger_doc.dig(:paths, "/stubs", :post, :requestBody)
+            expect(tree[:required]).to eq(true)
+          end
+        end
+      end
+    end
+  end
+
   describe 'Responses'
   describe 'Data Models (Schemas)'
   describe 'Examples'
diff --git a/test-app/swagger/v3/openapi.json b/test-app/swagger/v3/openapi.json
index a344f69fc..19983c04e 100644
--- a/test-app/swagger/v3/openapi.json
+++ b/test-app/swagger/v3/openapi.json
@@ -22,6 +22,30 @@
             "in": "query"
           }
         ]
+      },
+      "post": {
+        "summary": "body is required",
+        "tags": [
+          "Media Types"
+        ],
+        "parameters": [
+
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "file"
+              }
+            }
+          },
+          "required": true
+        }
       }
     },
     "/stubs/{a_param}": {

From 206c088d742e1f323dc32eceef19548ffcde85cc Mon Sep 17 00:00:00 2001
From: Jamie Macey <jamie.git@tracefunc.com>
Date: Sat, 17 Oct 2020 14:16:21 -0700
Subject: [PATCH 33/61] WIP-branch changelog updates

---
 CHANGELOG.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c79df1881..75036cd9e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,15 +1,17 @@
 # rswag
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 ### Added
+- RequestBody now supports the `required` flag [#342](https://github.com/rswag/rswag/pull/342)
 ### Changed
 ### Deprecated
 ### Removed
 ### Fixed
+- Fix response example rendering [#330](https://github.com/rswag/rswag/pull/330)
+- Fix empty content block [#347](https://github.com/rswag/rswag/pull/347)
 ### Security
 
 ## [2.3.1] - 2020-04-08

From ad95f1098ad5d284f29309e737384790ca04dba2 Mon Sep 17 00:00:00 2001
From: Alexander <aheaven87@gmail.com>
Date: Fri, 22 Jan 2021 13:25:27 +0200
Subject: [PATCH 34/61] Inherit consumes from swagger schema. Addresses #320.

---
 rswag-specs/lib/rswag/specs/swagger_formatter.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 0b15f1236..99b59120a 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -56,7 +56,7 @@ def stop(_notification = nil)
                 is_hash = value.is_a?(Hash)
                 if is_hash && value.dig(:parameters)
                   schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
-                  mime_list = value.dig(:consumes)
+                  mime_list = value.dig(:consumes) || doc[:consumes]
                   if value && schema_param && mime_list
                     value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
                     mime_list.each do |mime|

From 465950a65cf63fdbf9b885d606dc1799cbc30de9 Mon Sep 17 00:00:00 2001
From: Paul Filipow <paul@filipow.ca>
Date: Mon, 25 Jan 2021 16:11:54 -0800
Subject: [PATCH 35/61] don't clobber response content

---
 rswag-specs/lib/rswag/specs/swagger_formatter.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 99b59120a..94ff6eb5f 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -129,7 +129,7 @@ def upgrade_response_produces!(swagger_doc, metadata)
       end
 
       def upgrade_content!(mime_list, target_node)
-        target_node.merge!(content: {})
+        target_node.merge!(content: {}) if target_node[:content].nil?
         schema = target_node[:schema]
         return if mime_list.empty? || schema.nil?
 

From bd48e405291702d3d5d512489d52975928ef8087 Mon Sep 17 00:00:00 2001
From: Paul Filipow <paul@filipow.ca>
Date: Mon, 25 Jan 2021 21:12:16 -0800
Subject: [PATCH 36/61] add schema to mime type instead of overwriting

---
 rswag-specs/lib/rswag/specs/swagger_formatter.rb | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 94ff6eb5f..7fb9e6122 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -135,7 +135,8 @@ def upgrade_content!(mime_list, target_node)
 
         mime_list.each do |mime_type|
           # TODO upgrade to have content-type specific schema
-          target_node[:content][mime_type] = { schema: schema }
+          target_node[:content][mime_type] = {} if target_node[:content][mime_type].nil?
+          target_node[:content][mime_type][:schema] = schema
         end
       end
 

From b63dd343afd2ffc4962c81e533fced019a460e6c Mon Sep 17 00:00:00 2001
From: Paul Filipow <paul@filipow.ca>
Date: Tue, 26 Jan 2021 13:57:44 -0800
Subject: [PATCH 37/61] safe navigation in build_query_string_part

---
 rswag-specs/lib/rswag/specs/request_factory.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index 2e8f3f1da..2211fd03e 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -118,7 +118,7 @@ def add_path(request, metadata, swagger_doc, parameters, example)
 
       def build_query_string_part(param, value)
         name = param[:name]
-        return "#{name}=#{value}" unless param[:type].to_sym == :array
+        return "#{name}=#{value}" unless param[:type]&.to_sym == :array
 
         case param[:collectionFormat]
         when :ssv

From 670c94cc445c1fcf3601f48ba6f7dc277bd91d71 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Wed, 27 Jan 2021 14:53:15 -0700
Subject: [PATCH 38/61] Update version to 2.3.2 in changelog

---
 CHANGELOG.md | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 75036cd9e..b8e274265 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,15 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [2.3.2] - 2021-01-27
 ### Added
 - RequestBody now supports the `required` flag [#342](https://github.com/rswag/rswag/pull/342)
-### Changed
-### Deprecated
-### Removed
 ### Fixed
 - Fix response example rendering [#330](https://github.com/rswag/rswag/pull/330)
 - Fix empty content block [#347](https://github.com/rswag/rswag/pull/347)
-### Security
 
 ## [2.3.1] - 2020-04-08
 ### Fixed

From cbaf6cd3e44c317948520f96abb1e42eb379fef5 Mon Sep 17 00:00:00 2001
From: Donatas Povilaitis <ddonatasjar@gmail.com>
Date: Fri, 29 Jan 2021 20:47:46 +0200
Subject: [PATCH 39/61] Fix response examples

---
 .../lib/rswag/specs/swagger_formatter.rb      |  3 +-
 .../rswag/specs/swagger_formatter_spec.rb     | 44 ++++++++++++++++++-
 2 files changed, 44 insertions(+), 3 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 61672b79d..8b395d24d 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -132,9 +132,8 @@ def upgrade_response_produces!(swagger_doc, metadata)
       def upgrade_content!(mime_list, target_node)
         schema = target_node[:schema]
         return if mime_list.empty? || schema.nil?
-        target_node[:content] ||= {}
-        target_node.merge!(content: {})
 
+        target_node[:content] ||= {}
         mime_list.each do |mime_type|
           # TODO upgrade to have content-type specific schema
           (target_node[:content][mime_type] ||= {}).merge!(schema: schema)
diff --git a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
index f6277d5f9..64d6a0c0f 100644
--- a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
+++ b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
@@ -28,10 +28,11 @@ module Specs
           {
             path_item: { template: '/blogs', parameters: [{ type: :string }] },
             operation: { verb: :post, summary: 'Creates a blog', parameters: [{ type: :string }] },
-            response: { code: '201', description: 'blog created', headers: { type: :string }, schema: { '$ref' => '#/definitions/blog' } },
+            response: response_metadata,
             document: document
           }
         end
+        let(:response_metadata) { { code: '201', description: 'blog created', headers: { type: :string }, schema: { '$ref' => '#/definitions/blog' } } }
 
         context 'with the document tag set to false' do
           let(:swagger_doc) { { swagger: '2.0' } }
@@ -129,6 +130,47 @@ module Specs
             )
           end
 
+          context 'with response example' do
+            let(:response_metadata) do
+              {
+                code: '201',
+                description: 'blog created',
+                headers: { type: :string },
+                content: { 'application/json' => { example: { foo: :bar } } },
+                schema: { '$ref' => '#/definitions/blog' }
+              }
+            end
+
+            it 'adds example to definition' do
+              expect(swagger_doc.slice(:paths)).to match(
+                paths: {
+                  '/blogs' => {
+                    parameters: [{ schema: { type: :string } }],
+                    post: {
+                      parameters: [{ schema: { type: :string } }],
+                      summary: 'Creates a blog',
+                      responses: {
+                        '201' => {
+                          content: {
+                            'application/vnd.my_mime' => {
+                              schema: { '$ref' => '#/definitions/blog' }
+                            },
+                            'application/json' => {
+                              schema: { '$ref' => '#/definitions/blog' },
+                              example: { foo: :bar }
+                            }
+                          },
+                          description: 'blog created',
+                          headers: { schema: { type: :string } }
+                        }
+                      }
+                    }
+                  }
+                }
+              )
+            end
+          end
+
           context 'with empty content' do
             let(:swagger_doc) do
               {

From aa4e6f20706c1c482ab3e50bcfcb3a72d02d93b1 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Sat, 6 Feb 2021 17:42:23 -0700
Subject: [PATCH 40/61] Include example definition in test app

From changes in this commit: eadaf34ef6458da4bd8d03a028e5559a2cf7783b

we need to include the new output in the test-app swagger.json file
---
 test-app/swagger/v1/swagger.json | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 5586d8071..866f24016 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -221,6 +221,12 @@
             },
             "content": {
               "application/json": {
+                "example": {
+                  "id": 1,
+                  "title": "Hello world!",
+                  "content": "Hello world and hello universe. Thank you all very much!!!",
+                  "thumbnail": "thumbnail.png"
+                },
                 "schema": {
                   "$ref": "#/definitions/blog"
                 }

From 1f4ecb3c10f92d2c1cfdbbd3af2113d39c9f95ec Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Sun, 7 Feb 2021 06:31:47 -0700
Subject: [PATCH 41/61] update changelog

---
 CHANGELOG.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b8e274265..748fd2e60 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Fixed
+- Include response examples [#394](https://github.com/rswag/rswag/pull/394)
+
 ## [2.3.2] - 2021-01-27
 ### Added
 - RequestBody now supports the `required` flag [#342](https://github.com/rswag/rswag/pull/342)

From c0142093d41f725d78b9348b130ec0e9dbdf68b3 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Sun, 7 Feb 2021 07:47:52 -0700
Subject: [PATCH 42/61] Update swagger-ui to 3.42.0

---
 CHANGELOG.md               | 3 +++
 README.md                  | 2 +-
 rswag-ui/package-lock.json | 6 +++---
 rswag-ui/package.json      | 2 +-
 4 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 748fd2e60..934c8d1ba 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Fixed
 - Include response examples [#394](https://github.com/rswag/rswag/pull/394)
 
+### Changed
+- Update swagger-ui to 3.42.0
+
 ## [2.3.2] - 2021-01-27
 ### Added
 - RequestBody now supports the `required` flag [#342](https://github.com/rswag/rswag/pull/342)
diff --git a/README.md b/README.md
index f870dd663..5ec97ce96 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
 
 |Rswag Version|Swagger (OpenAPI) Spec.|swagger-ui|
 |----------|----------|----------|
-|[master](https://github.com/rswag/rswag/tree/master)|3.0.3|3.28.0|
+|[master](https://github.com/rswag/rswag/tree/master)|3.0.3|3.42.0|
 |[2.3.0](https://github.com/rswag/rswag/tree/2.3.0)|3.0.3|3.23.11|
 |[2.2.0](https://github.com/rswag/rswag/tree/2.2.0)|2.0|3.18.2|
 |[1.6.0](https://github.com/rswag/rswag/tree/1.6.0)|2.0|2.2.5|
diff --git a/rswag-ui/package-lock.json b/rswag-ui/package-lock.json
index 4c73fc0fa..4c083ef40 100644
--- a/rswag-ui/package-lock.json
+++ b/rswag-ui/package-lock.json
@@ -5,9 +5,9 @@
   "requires": true,
   "dependencies": {
     "swagger-ui-dist": {
-      "version": "3.28.0",
-      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.28.0.tgz",
-      "integrity": "sha512-aPkfTzPv9djSiZI1NUkWr5HynCUsH+jaJ0WSx+/t19wq7MMGg9clHm9nGoIpAtqml1G51ofI+I75Ym72pukzFg=="
+      "version": "3.42.0",
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.42.0.tgz",
+      "integrity": "sha512-hTNX6cX7KWtBZgk6ZQSOzsBJhqdCmD5NOIjb6dBPKSnYZidSkIXOcaPMR3+kwxLrj8bDC881bSDlNbLsHikacg=="
     }
   }
 }
diff --git a/rswag-ui/package.json b/rswag-ui/package.json
index e52d56157..65d525ec3 100644
--- a/rswag-ui/package.json
+++ b/rswag-ui/package.json
@@ -3,6 +3,6 @@
   "version": "1.0.0",
   "private": true,
   "dependencies": {
-    "swagger-ui-dist": "3.28.0"
+    "swagger-ui-dist": "3.42.0"
   }
 }

From 7ef900ec1d2ca8c20e830bad641cced59cc76afe Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Sun, 7 Feb 2021 07:55:52 -0700
Subject: [PATCH 43/61] version bump

---
 CHANGELOG.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 934c8d1ba..d25429690 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [2.3.3] - 2021-02-07
+
 ### Fixed
 - Include response examples [#394](https://github.com/rswag/rswag/pull/394)
 

From 0aca50c66c32d169754a476721d66522ebaee968 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Tue, 9 Feb 2021 11:51:34 -0700
Subject: [PATCH 44/61] Update changelog with 2.4.0 info

---
 CHANGELOG.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d25429690..39b101406 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [2.4.0] - 2021-02-09
+### Added
+- Added `SWAGGER_DRY_RUN` env variable [#274](https://github.com/rswag/rswag/pull/274)
+
 ## [2.3.3] - 2021-02-07
 
 ### Fixed

From 3d3d93f3abd4dcb0cbcb06e08173564af7189945 Mon Sep 17 00:00:00 2001
From: Serg F <wolferingys@gmail.com>
Date: Fri, 19 Feb 2021 15:15:44 +0300
Subject: [PATCH 45/61] Allow use #/components/parameters and other in
 inherited $refs

---
 rswag-specs/lib/rswag/specs/response_validator.rb | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/response_validator.rb b/rswag-specs/lib/rswag/specs/response_validator.rb
index 2c548741f..23b2c34b0 100644
--- a/rswag-specs/lib/rswag/specs/response_validator.rb
+++ b/rswag-specs/lib/rswag/specs/response_validator.rb
@@ -62,7 +62,7 @@ def definitions_or_component_schemas(swagger_doc, version)
             swagger_doc.slice(:definitions)
           else
             components = swagger_doc[:components] || {}
-            { components: { schemas: components[:schemas] } }
+            { components: components }
           end
         end
       end

From 4b7ab9d381fe937f21385d45149744d9ba351782 Mon Sep 17 00:00:00 2001
From: Igor Victor <gogainda@yandex.ru>
Date: Fri, 26 Feb 2021 17:58:30 +0100
Subject: [PATCH 46/61] Add Truffleruby head to CI

---
 .github/workflows/ruby.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index fd15653a6..beb315c6a 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7]
+        ruby: [2.6, 2.7, truffleruby-head]
         rails: [5.2.4.4, 6.0.3.4]
     env:
       RAILS_VERSION: ${{ matrix.rails }}

From a34c931bb6b2f7097340792313d9555a9419e7bd Mon Sep 17 00:00:00 2001
From: mynnx <mark@binti.com>
Date: Wed, 3 Mar 2021 16:32:16 -0800
Subject: [PATCH 47/61] Show the response body for comparison when schema
 checks fail

---
 rswag-specs/lib/rswag/specs/response_validator.rb | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/response_validator.rb b/rswag-specs/lib/rswag/specs/response_validator.rb
index 2c548741f..b09d44a60 100644
--- a/rswag-specs/lib/rswag/specs/response_validator.rb
+++ b/rswag-specs/lib/rswag/specs/response_validator.rb
@@ -50,7 +50,11 @@ def validate_body!(metadata, swagger_doc, body)
           .merge(schemas)
 
         errors = JSON::Validator.fully_validate(validation_schema, body)
-        raise UnexpectedResponse, "Expected response body to match schema: #{errors[0]}" if errors.any?
+        return unless errors.any?
+
+        raise UnexpectedResponse,
+              "Expected response body to match schema: #{errors[0]}\n" \
+              "Response body: #{JSON.pretty_generate(JSON.parse(body))}"
       end
 
       def definitions_or_component_schemas(swagger_doc, version)

From b91b6e5f1e011cc698a1d6a911110b0399a1a5b6 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Fri, 5 Mar 2021 21:34:00 -0700
Subject: [PATCH 48/61] Fix bundler warning

Move rswag-specs under development and test to resolve this warning:

```
Your Gemfile lists the gem rswag-specs (>= 0) more than once.
You should probably keep only one of them.
Remove any duplicate entries and specify the gem only once.
While it's not a problem now, it could cause errors if you change the version of one of them later.
```
---
 Gemfile | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/Gemfile b/Gemfile
index 38bb3ad70..481889773 100644
--- a/Gemfile
+++ b/Gemfile
@@ -25,18 +25,20 @@ end
 gem 'rswag-api', path: './rswag-api'
 gem 'rswag-ui', path: './rswag-ui'
 
+group :development, :test do
+  gem 'rswag-specs', path: './rswag-specs'
+end
+
 group :test do
   gem 'capybara'
   gem 'geckodriver-helper'
   gem 'generator_spec'
   gem 'rspec-rails'
   gem 'selenium-webdriver'
-  gem 'rswag-specs', path: './rswag-specs'
   gem 'test-unit'
 end
 
 group :development do
-  gem 'rswag-specs', path: './rswag-specs'
   gem 'rubocop'
 end
 

From 989aab656f34a0f6a4586979abf579e60aee0c26 Mon Sep 17 00:00:00 2001
From: Blake Erickson <o.blakeerickson@gmail.com>
Date: Sat, 6 Mar 2021 14:52:49 -0700
Subject: [PATCH 49/61] Revert "Add a macro for complexes multiparts"

---
 .../lib/rswag/specs/request_factory.rb        | 16 +------
 .../spec/rswag/specs/request_factory_spec.rb  | 14 ------
 test-app/app/controllers/blogs_controller.rb  |  6 ---
 test-app/config/routes.rb                     |  1 -
 test-app/spec/features/swagger_ui_spec.rb     |  1 -
 test-app/spec/integration/blogs_spec.rb       | 27 -----------
 test-app/swagger/v1/swagger.json              | 46 -------------------
 7 files changed, 1 insertion(+), 110 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index 3e6237a70..523b50f08 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -186,22 +186,8 @@ def build_form_payload(parameters, example)
         # Rather that serializing with the appropriate encoding (e.g. multipart/form-data),
         # Rails test infrastructure allows us to send the values directly as a hash
         # PROS: simple to implement, CONS: serialization/deserialization is bypassed in test
-        smart_payload = build_smart_form_payload(parameters, example)
-        raw_payload = build_raw_form_payload(parameters, example)
-
-        smart_payload.merge(raw_payload)
-      end
-
-      def build_smart_form_payload(parameters, example)
-        smart_tuples = parameters
-          .select { |p| p[:in] == :formData && p[:schema] }
-          .map { |p| example.send(p[:name]) }
-          .reduce({}, :merge)
-      end
-
-      def build_raw_form_payload(parameters, example)
         tuples = parameters
-          .select { |p| p[:in] == :formData && !p[:schema] }
+          .select { |p| p[:in] == :formData }
           .map { |p| [p[:name], example.send(p[:name])] }
         Hash[tuples]
       end
diff --git a/rswag-specs/spec/rswag/specs/request_factory_spec.rb b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
index 0269bd82d..aff5fb4eb 100644
--- a/rswag-specs/spec/rswag/specs/request_factory_spec.rb
+++ b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
@@ -178,20 +178,6 @@ module Specs
               )
             end
           end
-
-          context 'smart form payload' do
-            before do
-              metadata[:operation][:consumes] = ['multipart/form-data']
-              metadata[:operation][:parameters] = [{ name: 'comment', in: :formData, schema: { type: 'object' } }]
-              allow(example).to receive(:comment).and_return(text: 'Some comment')
-            end
-
-            it 'sets payload to hash of names and example values' do
-              expect(request[:payload]).to eq(
-                :text => 'Some comment'
-              )
-            end
-          end
         end
 
         context 'produces content' do
diff --git a/test-app/app/controllers/blogs_controller.rb b/test-app/app/controllers/blogs_controller.rb
index 80216ab2a..3bf6e5e09 100644
--- a/test-app/app/controllers/blogs_controller.rb
+++ b/test-app/app/controllers/blogs_controller.rb
@@ -8,12 +8,6 @@ def create
     respond_with @blog
   end
 
-  # POST /blogs/multipart
-  def multipart_create
-    @blog = Blog.create(params.require(:blog).permit(:title, :content))
-    respond_with @blog
-  end
-
   # POST /blogs/flexible
   def flexible_create
 
diff --git a/test-app/config/routes.rb b/test-app/config/routes.rb
index d72365a4a..3107e95a7 100644
--- a/test-app/config/routes.rb
+++ b/test-app/config/routes.rb
@@ -1,6 +1,5 @@
 TestApp::Application.routes.draw do
 
-  post '/blogs/multipart', to: 'blogs#multipart_create'
   post '/blogs/flexible', to: 'blogs#flexible_create'
   post '/blogs/alternate', to: 'blogs#alternate_create'
   resources :blogs
diff --git a/test-app/spec/features/swagger_ui_spec.rb b/test-app/spec/features/swagger_ui_spec.rb
index e76f08813..7c86110a1 100644
--- a/test-app/spec/features/swagger_ui_spec.rb
+++ b/test-app/spec/features/swagger_ui_spec.rb
@@ -8,7 +8,6 @@
 
     expect(page).to have_content('GET /blogs Searches blogs', normalize_ws: true)
     expect(page).to have_content('POST /blogs Creates a blog', normalize_ws: true)
-    expect(page).to have_content('POST /blogs/multipart Creates a blog using multipart', normalize_ws: true)
     expect(page).to have_content('GET /blogs/{id} Retrieves a blog', normalize_ws: true)
   end
 end
diff --git a/test-app/spec/integration/blogs_spec.rb b/test-app/spec/integration/blogs_spec.rb
index f0adb6edd..bfe67b697 100644
--- a/test-app/spec/integration/blogs_spec.rb
+++ b/test-app/spec/integration/blogs_spec.rb
@@ -53,33 +53,6 @@
     end
   end
 
-  path '/blogs/multipart' do
-    post 'Creates a blog using multipart' do
-      tags 'Blogs'
-      description 'Creates a new blog from provided data'
-      operationId 'createBlogWithMultipart'
-      consumes 'multipart/form-data'
-      produces 'application/json'
-      parameter name: :blog, in: :formData, schema: { type: :object, properties: { name: :blog, type: :object, properties: { '$ref' => '#/definitions/blog' } } }
-
-      let(:blog) { { blog: { title: 'foo', content: 'bar' } } }
-
-      response '201', 'blog created' do
-        # schema '$ref' => '#/definitions/blog'
-        run_test!
-      end
-
-      response '422', 'invalid request' do
-        schema '$ref' => '#/definitions/errors_object'
-
-        let(:blog) { { blog: { title: 'foo' } } }
-        run_test! do |response|
-          expect(response.body).to include("can't be blank")
-        end
-      end
-    end
-  end
-
   path '/blogs/flexible' do
     post 'Creates a blog flexible body' do
       tags 'Blogs'
diff --git a/test-app/swagger/v1/swagger.json b/test-app/swagger/v1/swagger.json
index 9759fc271..866f24016 100644
--- a/test-app/swagger/v1/swagger.json
+++ b/test-app/swagger/v1/swagger.json
@@ -139,52 +139,6 @@
         }
       }
     },
-    "/blogs/multipart": {
-      "post": {
-        "summary": "Creates a blog using multipart",
-        "tags": [
-          "Blogs"
-        ],
-        "description": "Creates a new blog from provided data",
-        "operationId": "createBlogWithMultipart",
-        "parameters": [
-
-        ],
-        "responses": {
-          "201": {
-            "description": "blog created",
-            "content": {
-            }
-          },
-          "422": {
-            "description": "invalid request",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/definitions/errors_object"
-                }
-              }
-            }
-          }
-        },
-        "requestBody": {
-          "content": {
-            "multipart/form-data": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "name": "blog",
-                  "type": "object",
-                  "properties": {
-                    "$ref": "#/definitions/blog"
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    },
     "/blogs/flexible": {
       "post": {
         "summary": "Creates a blog flexible body",

From 4a32108f783cabc7fd2c74a1a566221d56709e60 Mon Sep 17 00:00:00 2001
From: mynnx <mark@binti.com>
Date: Thu, 8 Apr 2021 15:44:07 -0700
Subject: [PATCH 50/61] Document using multiple tags

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 6de962edd..356662ec6 100644
--- a/README.md
+++ b/README.md
@@ -136,7 +136,7 @@ There is also a generator which can help get you started `rails generate rspec:s
       path '/blogs/{id}' do
 
         get 'Retrieves a blog' do
-          tags 'Blogs'
+          tags 'Blogs', 'Another Tag'
           produces 'application/json', 'application/xml'
           parameter name: :id, in: :path, type: :string
 

From 1d2a25e23164e91f5ef207cc86e6aebe3aeb9b4c Mon Sep 17 00:00:00 2001
From: Sarah Ridge <sarah@cobalt.io>
Date: Mon, 10 May 2021 23:21:59 -0400
Subject: [PATCH 51/61] Update Contributing Doc with Bundle Install
 Troubleshooting

---
 CONTRIBUTING.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 84ae9dfe8..c5e9eb9be 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,6 +29,24 @@ npm install
 cd -
 ```
 
+### Troubleshooting:
+- `libv8` or `therubyracer` MacOS Catalina/Big Sur install issues:
+  ```
+  An error occurred while installing libv8 (3.16.14.19), and Bundler cannot continue.
+  Make sure that `gem install libv8 -v '3.16.14.19' --source 'https://rubygems.org/'` succeeds before bundling.
+
+  An error occurred while installing therubyracer (0.12.3), and Bundler cannot continue.
+  Make sure that `gem install therubyracer -v '0.12.3' --source 'https://rubygems.org/'` succeeds before bundling.
+  ```
+
+  Try, [reference](https://stackoverflow.com/a/62413041/7477016):
+  ```
+  brew install v8@3.15
+  bundle config build.libv8 --with-system-v8
+  bundle config build.therubyracer --with-v8-dir=$(brew --prefix v8@3.15)
+  bundle
+  ```
+
 ## Test
 Initialize the rswag-ui repo with assets.
 ```

From c85fa3b37a18dff6df86077f2a72f9851705daeb Mon Sep 17 00:00:00 2001
From: Greg Myers <neonmd@hotmail.co.uk>
Date: Wed, 16 Jun 2021 14:46:04 +0100
Subject: [PATCH 52/61] Update README.md

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 356662ec6..190ed3576 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@ rswag
 
 OpenApi 3.0 and Swagger 2.0 compatible!
 
+Seeking maintainers! Got a pet-bug that needs fixing? Just let us know in your issue/pr that you'd like to step up to help.
+
 Rswag extends rspec-rails "request specs" with a Swagger-based DSL for describing and testing API operations. You describe your API operations with a succinct, intuitive syntax, and it automaticaly runs the tests. Once you have green tests, run a rake task to auto-generate corresponding Swagger files and expose them as YAML or JSON endpoints. Rswag also provides an embedded version of the awesome [swagger-ui](https://github.com/swagger-api/swagger-ui) that's powered by the exposed file. This toolchain makes it seamless to go from integration specs, which youre probably doing in some form already, to living documentation for your API consumers.
 
 Api Rswag creates [Swagger](http://swagger.io) tooling for Rails API's. Generate beautiful API documentation, including a UI to explore and test operations, directly from your rspec integration tests.

From 42c8e123a803e2d5962f472c3b5ac55af4d5df02 Mon Sep 17 00:00:00 2001
From: Jay Dorsey <191564+jaydorsey@users.noreply.github.com>
Date: Sun, 8 Aug 2021 22:40:33 -0400
Subject: [PATCH 53/61] Replace therubyracer with mini_racer

therubyracer doesn't appear to be under active development

I didn't need this for PRs that I was doing, but a `bundle install`
failed because of it. I know I can specify the groups as a workaround
but replacing this seems like it might reduce a small barrier to
contributing
---
 Gemfile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Gemfile b/Gemfile
index 481889773..f7ce082a4 100644
--- a/Gemfile
+++ b/Gemfile
@@ -43,7 +43,7 @@ group :development do
 end
 
 group :assets do
-  gem 'therubyracer'
+  gem 'mini_racer'
   gem 'uglifier'
 end
 

From a40a06646f274313fe9d33c60e0469d93e83f860 Mon Sep 17 00:00:00 2001
From: Jay Dorsey <191564+jaydorsey@users.noreply.github.com>
Date: Sun, 8 Aug 2021 22:58:11 -0400
Subject: [PATCH 54/61] Remove therubyracer from contributing

---
 CONTRIBUTING.md | 22 ++--------------------
 1 file changed, 2 insertions(+), 20 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c5e9eb9be..dc7b71936 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -29,24 +29,6 @@ npm install
 cd -
 ```
 
-### Troubleshooting:
-- `libv8` or `therubyracer` MacOS Catalina/Big Sur install issues:
-  ```
-  An error occurred while installing libv8 (3.16.14.19), and Bundler cannot continue.
-  Make sure that `gem install libv8 -v '3.16.14.19' --source 'https://rubygems.org/'` succeeds before bundling.
-
-  An error occurred while installing therubyracer (0.12.3), and Bundler cannot continue.
-  Make sure that `gem install therubyracer -v '0.12.3' --source 'https://rubygems.org/'` succeeds before bundling.
-  ```
-
-  Try, [reference](https://stackoverflow.com/a/62413041/7477016):
-  ```
-  brew install v8@3.15
-  bundle config build.libv8 --with-system-v8
-  bundle config build.therubyracer --with-v8-dir=$(brew --prefix v8@3.15)
-  bundle
-  ```
-
 ## Test
 Initialize the rswag-ui repo with assets.
 ```
@@ -75,11 +57,11 @@ Push to your fork and [submit a Pull Request][pr].
 
 ## Updating Swagger UI
 
-Find the latest versions of swagger-ui here:  
+Find the latest versions of swagger-ui here:
 https://github.com/swagger-api/swagger-ui/releases
 
 Update the swagger-ui-dist version in the rswag-ui dependencies
-```  
+```
 ./rswag-ui/package.json
 ```
 

From dd6530b7181f68bdb79992c1390453bba3c30a78 Mon Sep 17 00:00:00 2001
From: Mark Siemers <mark.siemers@measurabl.com>
Date: Wed, 22 Sep 2021 17:32:58 -0400
Subject: [PATCH 55/61] Loosen gemspec requirement to allow rails 7.0

---
 rswag-api/rswag-api.gemspec     | 2 +-
 rswag-specs/rswag-specs.gemspec | 4 ++--
 rswag-ui/rswag-ui.gemspec       | 4 ++--
 3 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/rswag-api/rswag-api.gemspec b/rswag-api/rswag-api.gemspec
index 850be0f35..0cbfd9915 100644
--- a/rswag-api/rswag-api.gemspec
+++ b/rswag-api/rswag-api.gemspec
@@ -15,5 +15,5 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile']
 
-  s.add_dependency 'railties', '>= 3.1', '< 7.0'
+  s.add_dependency 'railties', '>= 3.1', '< 7.1'
 end
diff --git a/rswag-specs/rswag-specs.gemspec b/rswag-specs/rswag-specs.gemspec
index 44f644b89..18434abb0 100644
--- a/rswag-specs/rswag-specs.gemspec
+++ b/rswag-specs/rswag-specs.gemspec
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir['{lib}/**/*'] + ['MIT-LICENSE', 'Rakefile']
 
-  s.add_dependency 'activesupport', '>= 3.1', '< 7.0'
-  s.add_dependency 'railties', '>= 3.1', '< 7.0'
+  s.add_dependency 'activesupport', '>= 3.1', '< 7.1'
+  s.add_dependency 'railties', '>= 3.1', '< 7.1'
   s.add_dependency 'json-schema', '~> 2.2'
 end
diff --git a/rswag-ui/rswag-ui.gemspec b/rswag-ui/rswag-ui.gemspec
index 86436729e..7dc973442 100644
--- a/rswag-ui/rswag-ui.gemspec
+++ b/rswag-ui/rswag-ui.gemspec
@@ -15,6 +15,6 @@ Gem::Specification.new do |s|
 
   s.files = Dir.glob('{lib,node_modules}/**/*') + ['MIT-LICENSE', 'Rakefile' ]
 
-  s.add_dependency 'actionpack', '>=3.1', '< 7.0'
-  s.add_dependency 'railties', '>= 3.1', '< 7.0'
+  s.add_dependency 'actionpack', '>=3.1', '< 7.1'
+  s.add_dependency 'railties', '>= 3.1', '< 7.1'
 end

From 32638062d7a028f0d1d72ba27024e42181912a22 Mon Sep 17 00:00:00 2001
From: Jay Dorsey <191564+jaydorsey@users.noreply.github.com>
Date: Fri, 6 Aug 2021 23:09:56 -0400
Subject: [PATCH 56/61] Better error message for missing let

I've run into this problem a number of times. The original error message
is actually a `NoMethodError` and it's not always immediately clear what
the solution is, particuarly if you're new to rspec or rswag

Wanted to see if this kind of behavior is something that the rswag team
would be interested in adopting. I have a few other of these in mind
(will do as small PRs, with tests)
---
 .../lib/rswag/specs/request_factory.rb        | 26 ++++++++++++++++++-
 .../spec/rswag/specs/request_factory_spec.rb  | 15 +++++++++++
 2 files changed, 40 insertions(+), 1 deletion(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index 523b50f08..f7b9fce0f 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -194,12 +194,36 @@ def build_form_payload(parameters, example)
 
       def build_json_payload(parameters, example)
         body_param = parameters.select { |p| p[:in] == :body }.first
-        body_param ? example.send(body_param[:name]).to_json : nil
+
+        return nil unless body_param
+
+        raise(MissingParameterError, body_param[:name]) unless example.respond_to?(body_param[:name])
+
+        example.send(body_param[:name]).to_json
       end
 
       def doc_version(doc)
         doc[:openapi] || doc[:swagger] || '3'
       end
     end
+
+    class MissingParameterError < StandardError
+      attr_reader :body_param
+
+      def initialize(body_param)
+        @body_param = body_param
+      end
+
+      def message
+        <<~MSG
+          Missing parameter #{body_param}
+
+          Please check your spec. It looks like you defined a body parameter,
+          but did not declare usage via let. Try adding:
+
+              let(:#{body_param}) {}
+        MSG
+      end
+    end
   end
 end
diff --git a/rswag-specs/spec/rswag/specs/request_factory_spec.rb b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
index aff5fb4eb..a9faef27a 100644
--- a/rswag-specs/spec/rswag/specs/request_factory_spec.rb
+++ b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
@@ -160,6 +160,21 @@ module Specs
             end
           end
 
+          context 'missing body parameter' do
+            before do
+              metadata[:operation][:parameters] = [{ name: 'comment', in: :body, schema: { type: 'object' } }]
+              allow(example).to receive(:comment).and_raise(NoMethodError, "undefined method 'comment'")
+              allow(example).to receive(:respond_to?).with(:'Content-Type')
+              allow(example).to receive(:respond_to?).with('comment').and_return(false)
+            end
+
+            it 'uses the referenced metadata to build the request' do
+              expect do
+                request[:payload]
+              end.to raise_error(Rswag::Specs::MissingParameterError, /Missing parameter comment/)
+            end
+          end
+
           context 'form payload' do
             before do
               metadata[:operation][:consumes] = ['multipart/form-data']

From 86c512f639758dd389769c2c1d8de2c8e93a4f99 Mon Sep 17 00:00:00 2001
From: Jay Dorsey <191564+jaydorsey@users.noreply.github.com>
Date: Fri, 24 Sep 2021 16:11:44 -0400
Subject: [PATCH 57/61] Add single quotes around parameter name

---
 rswag-specs/lib/rswag/specs/request_factory.rb       | 2 +-
 rswag-specs/spec/rswag/specs/request_factory_spec.rb | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index f7b9fce0f..eb13b2d5f 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -216,7 +216,7 @@ def initialize(body_param)
 
       def message
         <<~MSG
-          Missing parameter #{body_param}
+          Missing parameter '#{body_param}'
 
           Please check your spec. It looks like you defined a body parameter,
           but did not declare usage via let. Try adding:
diff --git a/rswag-specs/spec/rswag/specs/request_factory_spec.rb b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
index a9faef27a..a26f69459 100644
--- a/rswag-specs/spec/rswag/specs/request_factory_spec.rb
+++ b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
@@ -171,7 +171,7 @@ module Specs
             it 'uses the referenced metadata to build the request' do
               expect do
                 request[:payload]
-              end.to raise_error(Rswag::Specs::MissingParameterError, /Missing parameter comment/)
+              end.to raise_error(Rswag::Specs::MissingParameterError, /Missing parameter 'comment'/)
             end
           end
 

From 6cafc0c0e5f02da33b439adde98914ee47c0f7c7 Mon Sep 17 00:00:00 2001
From: Jakub Sawicki <j.sawicki@cyfronet.pl>
Date: Fri, 15 Oct 2021 12:03:18 +0200
Subject: [PATCH 58/61] Update swagger-ui to 3.52.5

---
 CHANGELOG.md               | 3 +++
 README.md                  | 2 +-
 rswag-ui/package-lock.json | 6 +++---
 rswag-ui/package.json      | 2 +-
 4 files changed, 8 insertions(+), 5 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 39b101406..19df54dde 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Changed
+- Update swagger-ui to 3.52.5
+
 ## [2.4.0] - 2021-02-09
 ### Added
 - Added `SWAGGER_DRY_RUN` env variable [#274](https://github.com/rswag/rswag/pull/274)
diff --git a/README.md b/README.md
index 190ed3576..1cd4d5f5d 100644
--- a/README.md
+++ b/README.md
@@ -20,7 +20,7 @@ Once you have an API that can describe itself in Swagger, you've opened the trea
 
 |Rswag Version|Swagger (OpenAPI) Spec.|swagger-ui|
 |----------|----------|----------|
-|[master](https://github.com/rswag/rswag/tree/master)|3.0.3|3.42.0|
+|[master](https://github.com/rswag/rswag/tree/master)|3.0.3|3.52.5|
 |[2.3.0](https://github.com/rswag/rswag/tree/2.3.0)|3.0.3|3.23.11|
 |[2.2.0](https://github.com/rswag/rswag/tree/2.2.0)|2.0|3.18.2|
 |[1.6.0](https://github.com/rswag/rswag/tree/1.6.0)|2.0|2.2.5|
diff --git a/rswag-ui/package-lock.json b/rswag-ui/package-lock.json
index 4c083ef40..01f5ca7fb 100644
--- a/rswag-ui/package-lock.json
+++ b/rswag-ui/package-lock.json
@@ -5,9 +5,9 @@
   "requires": true,
   "dependencies": {
     "swagger-ui-dist": {
-      "version": "3.42.0",
-      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.42.0.tgz",
-      "integrity": "sha512-hTNX6cX7KWtBZgk6ZQSOzsBJhqdCmD5NOIjb6dBPKSnYZidSkIXOcaPMR3+kwxLrj8bDC881bSDlNbLsHikacg=="
+      "version": "3.52.5",
+      "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-3.52.5.tgz",
+      "integrity": "sha512-8z18eX8G/jbTXYzyNIaobrnD7PSN7yU/YkSasMmajrXtw0FGS64XjrKn5v37d36qmU3o1xLeuYnktshRr7uIFw=="
     }
   }
 }
diff --git a/rswag-ui/package.json b/rswag-ui/package.json
index 65d525ec3..47cd28f6b 100644
--- a/rswag-ui/package.json
+++ b/rswag-ui/package.json
@@ -3,6 +3,6 @@
   "version": "1.0.0",
   "private": true,
   "dependencies": {
-    "swagger-ui-dist": "3.42.0"
+    "swagger-ui-dist": "3.52.5"
   }
 }

From ec6b35523c481a70e6a3173076b1a03a380c8330 Mon Sep 17 00:00:00 2001
From: Stephen Ziyun Li <stephen.li@instacart.com>
Date: Mon, 10 Jan 2022 13:49:36 -0500
Subject: [PATCH 59/61] resolve conflicts

---
 .../lib/rswag/specs/request_factory.rb        |   8 +-
 .../lib/rswag/specs/swagger_formatter.rb      |  16 ++-
 .../spec/rswag/specs/request_factory_spec.rb  |  46 +++++++
 .../rswag/specs/swagger_formatter_spec.rb     | 118 ++++++++++++++++++
 4 files changed, 184 insertions(+), 4 deletions(-)

diff --git a/rswag-specs/lib/rswag/specs/request_factory.rb b/rswag-specs/lib/rswag/specs/request_factory.rb
index eb13b2d5f..94d395e28 100644
--- a/rswag-specs/lib/rswag/specs/request_factory.rb
+++ b/rswag-specs/lib/rswag/specs/request_factory.rb
@@ -111,12 +111,16 @@ def add_path(request, metadata, swagger_doc, parameters, example)
 
           parameters.select { |p| p[:in] == :query }.each_with_index do |p, i|
             path_template.concat(i.zero? ? '?' : '&')
-            path_template.concat(build_query_string_part(p, example.send(p[:name])))
+            path_template.concat(build_query_string_part(p, example.send(p[:name]), swagger_doc))
           end
         end
       end
 
-      def build_query_string_part(param, value)
+      def param_is_array?(param)
+        param[:type]&.to_sym == :array || param.dig(:schema, :type)&.to_sym == :array
+      end
+
+      def build_query_string_part(param, value, swagger_doc)
         name = param[:name]
         type = param[:type] || param.dig(:schema, :type)
         return "#{name}=#{value}" unless type&.to_sym == :array
diff --git a/rswag-specs/lib/rswag/specs/swagger_formatter.rb b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
index 8b395d24d..56cac5b3a 100644
--- a/rswag-specs/lib/rswag/specs/swagger_formatter.rb
+++ b/rswag-specs/lib/rswag/specs/swagger_formatter.rb
@@ -127,19 +127,31 @@ def upgrade_response_produces!(swagger_doc, metadata)
         target_node = metadata[:response]
         upgrade_content!(mime_list, target_node)
         metadata[:response].delete(:schema)
+        metadata[:response].delete(:examples)
       end
 
       def upgrade_content!(mime_list, target_node)
         schema = target_node[:schema]
-        return if mime_list.empty? || schema.nil?
+        examples = upgrade_examples(target_node[:examples])
+        return if mime_list.empty? || (schema.nil? && examples.nil?)
 
         target_node[:content] ||= {}
+        content = { schema: schema, examples: examples }.select { |_, v| v.present? }
         mime_list.each do |mime_type|
           # TODO upgrade to have content-type specific schema
-          (target_node[:content][mime_type] ||= {}).merge!(schema: schema)
+          target_node[:content][mime_type] = content
         end
       end
 
+      def upgrade_examples(examples)
+        return unless examples.present?
+        examples.map do |k, v|
+          [k, {
+            value: v
+          }]
+        end.to_h
+      end
+
       def upgrade_request_type!(metadata)
         # No deprecation here as it seems valid to allow type as a shorthand
         operation_nodes = metadata[:operation][:parameters] || []
diff --git a/rswag-specs/spec/rswag/specs/request_factory_spec.rb b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
index a26f69459..912ad1edb 100644
--- a/rswag-specs/spec/rswag/specs/request_factory_spec.rb
+++ b/rswag-specs/spec/rswag/specs/request_factory_spec.rb
@@ -103,6 +103,52 @@ module Specs
           end
         end
 
+        context "'query' parameters of type 'array' by way of 'schema'" do
+          let(:swagger_doc) { { swagger: '3.0.3' } }
+
+          before do
+            metadata[:operation][:parameters] = [
+              { name: 'things', in: :query, schema: { type: :array }, collectionFormat: collection_format }
+            ]
+            allow(example).to receive(:things).and_return(['foo', 'bar'])
+          end
+
+          context 'collectionFormat = csv' do
+            let(:collection_format) { :csv }
+            it 'formats as comma separated values' do
+              expect(request[:path]).to eq('/blogs?things=foo,bar')
+            end
+          end
+
+          context 'collectionFormat = ssv' do
+            let(:collection_format) { :ssv }
+            it 'formats as space separated values' do
+              expect(request[:path]).to eq('/blogs?things=foo bar')
+            end
+          end
+
+          context 'collectionFormat = tsv' do
+            let(:collection_format) { :tsv }
+            it 'formats as tab separated values' do
+              expect(request[:path]).to eq('/blogs?things=foo\tbar')
+            end
+          end
+
+          context 'collectionFormat = pipes' do
+            let(:collection_format) { :pipes }
+            it 'formats as pipe separated values' do
+              expect(request[:path]).to eq('/blogs?things=foo|bar')
+            end
+          end
+
+          context 'collectionFormat = multi' do
+            let(:collection_format) { :multi }
+            it 'formats as multiple parameter instances' do
+              expect(request[:path]).to eq('/blogs?things=foo&things=bar')
+            end
+          end
+        end
+
         context "'header' parameters" do
           before do
             metadata[:operation][:parameters] = [{ name: 'Api-Key', in: :header, type: :string }]
diff --git a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
index 64d6a0c0f..1a199caf0 100644
--- a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
+++ b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
@@ -102,6 +102,124 @@ module Specs
           end
           let(:document) { nil }
 
+          context 'when response contains examples' do
+            let(:api_response) do
+              {
+                 code: '201',
+                 description: 'blog created',
+                 headers: { type: :string },
+                 examples: {
+                   success: {
+                      id: 12345,
+                      name: "10 reasons to stop using ruby"
+                   }
+                }
+              }
+            end
+
+            it 'converts examples to match spec' do
+              expect(swagger_doc.dig(:paths, '/blogs',:post, :responses)).to match(
+                '201' => {
+                  content: {
+                    'application/vnd.my_mime' => {
+                      examples: {
+                        success: {
+                          value: {
+                            id: 12345,
+                            name: "10 reasons to stop using ruby"
+                          }
+                        }
+                      }
+                    },
+                    'application/json' => {
+                      examples: {
+                        success: {
+                          value: {
+                            id: 12345,
+                            name: "10 reasons to stop using ruby"
+                          }
+                        }
+                      }
+                    }
+                  },
+                  description: 'blog created',
+                  headers: { schema: { type: :string } }
+                }
+              )
+            end
+          end
+
+          context 'when example contains schema and examples' do
+            let(:api_response) do
+              {
+                 code: '201',
+                 description: 'blog created',
+                 headers: { type: :string },
+                 schema: {
+                   type: :object,
+                   properties: {
+                     id: { type: :number },
+                     name: { type: :string}
+                   },
+                   required: ['id', 'name']
+                 },
+                 examples: {
+                   success: {
+                      id: 12345,
+                      name: "10 reasons to stop using ruby"
+                   }
+                }
+              }
+            end
+
+            it 'converts schema and examples to match spec' do
+              expect(swagger_doc.dig(:paths, '/blogs',:post, :responses)).to match(
+                '201' => {
+                  content: {
+                    'application/vnd.my_mime' => {
+                      schema: {
+                        type: :object,
+                        properties: {
+                          id: { type: :number },
+                          name: { type: :string}
+                        },
+                        required: ['id', 'name']
+                      },
+                      examples: {
+                        success: {
+                          value: {
+                            id: 12345,
+                            name: "10 reasons to stop using ruby"
+                          }
+                        }
+                      }
+                    },
+                    'application/json' => {
+                      schema: {
+                        type: :object,
+                        properties: {
+                          id: { type: :number },
+                          name: { type: :string}
+                        },
+                        required: ['id', 'name']
+                      },
+                      examples: {
+                        success: {
+                          value: {
+                            id: 12345,
+                            name: "10 reasons to stop using ruby"
+                          }
+                        }
+                      }
+                    }
+                  },
+                  description: 'blog created',
+                  headers: { schema: { type: :string } }
+                }
+              )
+            end
+          end
+
           it 'converts query and path params, type: to schema: { type: }' do
             expect(swagger_doc.slice(:paths)).to match(
               paths: {

From cb949d60dd09eecf1686fb5b3007dd18f1174b06 Mon Sep 17 00:00:00 2001
From: Stephen Ziyun Li <stephen.li@instacart.com>
Date: Mon, 10 Jan 2022 14:44:23 -0500
Subject: [PATCH 60/61] use ruby version from matrix

---
 .github/workflows/ruby.yml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/.github/workflows/ruby.yml b/.github/workflows/ruby.yml
index beb315c6a..24ebf99ba 100644
--- a/.github/workflows/ruby.yml
+++ b/.github/workflows/ruby.yml
@@ -19,7 +19,9 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
-      with: { ruby-version: 2.6 }
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
 
     - uses: actions/cache@v2
       id: cache

From 9552c11a71559a7b0cd136aa0f6591e7f61a6519 Mon Sep 17 00:00:00 2001
From: Stephen Ziyun Li <stephen.li@instacart.com>
Date: Mon, 10 Jan 2022 17:01:39 -0500
Subject: [PATCH 61/61] fix tests

---
 .../rswag/specs/swagger_formatter_spec.rb     | 71 ++++++++++---------
 1 file changed, 38 insertions(+), 33 deletions(-)

diff --git a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
index 1a199caf0..118f064bb 100644
--- a/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
+++ b/rswag-specs/spec/rswag/specs/swagger_formatter_spec.rb
@@ -103,16 +103,16 @@ module Specs
           let(:document) { nil }
 
           context 'when response contains examples' do
-            let(:api_response) do
+            let(:response_metadata) do
               {
-                 code: '201',
-                 description: 'blog created',
-                 headers: { type: :string },
-                 examples: {
-                   success: {
-                      id: 12345,
-                      name: "10 reasons to stop using ruby"
-                   }
+                code: '201',
+                description: 'blog created',
+                headers: { type: :string },
+                examples: {
+                  success: {
+                    id: 12345,
+                    name: "10 reasons to love ruby"
+                  }
                 }
               }
             end
@@ -126,7 +126,7 @@ module Specs
                         success: {
                           value: {
                             id: 12345,
-                            name: "10 reasons to stop using ruby"
+                            name: "10 reasons to love ruby"
                           }
                         }
                       }
@@ -136,7 +136,7 @@ module Specs
                         success: {
                           value: {
                             id: 12345,
-                            name: "10 reasons to stop using ruby"
+                            name: "10 reasons to love ruby"
                           }
                         }
                       }
@@ -150,24 +150,24 @@ module Specs
           end
 
           context 'when example contains schema and examples' do
-            let(:api_response) do
+            let(:response_metadata) do
               {
-                 code: '201',
-                 description: 'blog created',
-                 headers: { type: :string },
-                 schema: {
-                   type: :object,
-                   properties: {
-                     id: { type: :number },
-                     name: { type: :string}
-                   },
-                   required: ['id', 'name']
-                 },
-                 examples: {
-                   success: {
-                      id: 12345,
-                      name: "10 reasons to stop using ruby"
-                   }
+                code: '201',
+                description: 'blog created',
+                headers: { type: :string },
+                schema: {
+                  type: :object,
+                  properties: {
+                    id: { type: :number },
+                    name: { type: :string}
+                  },
+                  required: ['id', 'name']
+                },
+                examples: {
+                  success: {
+                    id: 12345,
+                    name: "10 reasons to love ruby"
+                  }
                 }
               }
             end
@@ -189,7 +189,7 @@ module Specs
                         success: {
                           value: {
                             id: 12345,
-                            name: "10 reasons to stop using ruby"
+                            name: "10 reasons to love ruby"
                           }
                         }
                       }
@@ -207,7 +207,7 @@ module Specs
                         success: {
                           value: {
                             id: 12345,
-                            name: "10 reasons to stop using ruby"
+                            name: "10 reasons to love ruby"
                           }
                         }
                       }
@@ -254,7 +254,7 @@ module Specs
                 code: '201',
                 description: 'blog created',
                 headers: { type: :string },
-                content: { 'application/json' => { example: { foo: :bar } } },
+                examples: { foo: :bar },
                 schema: { '$ref' => '#/definitions/blog' }
               }
             end
@@ -271,11 +271,16 @@ module Specs
                         '201' => {
                           content: {
                             'application/vnd.my_mime' => {
-                              schema: { '$ref' => '#/definitions/blog' }
+                              schema: { '$ref' => '#/definitions/blog' },
+                              examples: { foo: {
+                                value: :bar,
+                              } }
                             },
                             'application/json' => {
                               schema: { '$ref' => '#/definitions/blog' },
-                              example: { foo: :bar }
+                              examples: { foo: {
+                                value: :bar,
+                              } }
                             }
                           },
                           description: 'blog created',