v3.0.0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -29,6 +29,5 @@ The version of are you using for:
 * Ruby:
 
 ## Relates to which version of OAS (OpenAPI Specification)
-- [ ] OAS2
 - [ ] OAS3
 - [ ] OAS3.1

.github/ISSUE_TEMPLATE/feature_request.md

@@ -24,6 +24,5 @@ A clear and concise description of any alternative solutions or features you've
 Add any other context or screenshots about the feature request here.
 
 ## Relates to which version of OAS (OpenAPI Specification)
-- [ ] OAS2
 - [ ] OAS3
 - [ ] OAS3.1

.github/pull_request_template.md

@@ -9,7 +9,6 @@ A clear and concise description of what the solution is.
 * [ANOTHER LINK TO RELEVANT OPEN API SPECS PAGE](https://spec.openapis.org/oas/v3.1.0#schema)
 
 ### The changes I made are compatible with:
-- [ ] OAS2
 - [ ] OAS3
 - [ ] OAS3.1
 

.github/workflows/ruby.yml

@@ -11,18 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [2.6, 2.7, 3.0, 3.1] # 2.6 is EOL March 31, 2022; kept for information only
-        rails: [5.2.6, 6.1.4.4, 7.0.1] # 5.2 EOL in 01 Jun 2022; kept for information only
-        exclude:
-        # excludes Rails 5.2.x on Ruby 3.0 and on 3.1 
-        # Note that 6.0.x should also exclude 3.0 and 3.1 but we're not testing it.
-        - rails: 5.2.6
-          ruby: 3.0
-        - rails: 5.2.6
-          ruby: 3.1
-        # Rails 7.0.1 requires >= 2.7.0, so excluding 2.6
-        - rails: 7.0.1
-          ruby: 2.6
+        ruby: [3.0, 3.1, 3.2] # 3.0 EOL is 2024-03-31
+        rails: [6.1.4.4, 7.0.4.3]
     env:
       RAILS_VERSION: ${{ matrix.rails }}
 

.ruby-version

@@ -1 +1 @@
-2.7.6
+3.0.6

CHANGELOG.md

@@ -4,6 +4,24 @@ 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).
 
+## [3.0.0]
+
+### Fixed
+
+- Dropped using #send (https://github.com/rswag/rswag/pull/396)
+
+### Added
+
+### Changed
+
+- Drop support for OpenAPI v2 (Swagger) (https://github.com/rswag/rswag/pull/574)
+- Drop Rspec V2 support (https://github.com/rswag/rswag/pull/636)
+- upgrade to ruby 3.0.6 and rails 7.0.4.3 in local dev (https://github.com/rswag/rswag/pull/625)
+
+### Documentation
+
+- fix README for new request_* pattern (https://github.com/rswag/rswag/pull/694)
+
 ## [Unreleased]
 
 ### Added
@@ -18,7 +36,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Documentation
 
-- Added more details about config swagger format [#698](https://github.com/rswag/rswag/pull/698)
+- Added more details about config swagger format (https://github.com/rswag/rswag/pull/698)
 
 ## [2.13.0]
 

Dockerfile

@@ -1,5 +1,5 @@
-FROM ruby:2.7
-ENV RAILS_VERSION 7.0.3.1
+FROM ruby:3.0
+ENV RAILS_VERSION 7.0.4.3
 
 RUN apt-get update -qq && apt-get install -y nodejs npm
 # Bugfix for https://github.com/rubyjs/mini_racer/issues/220#issuecomment-1010724771

Gemfile

@@ -17,11 +17,7 @@ when  '6', '7'
   gem 'sqlite3', '~> 1.4.1'
 end
 
-case RUBY_VERSION.split('.').first
-when '3'
-  gem 'net-smtp', require: false
-end
-
+gem 'net-smtp', require: false
 gem 'rswag-api', path: './rswag-api'
 gem 'rswag-ui', path: './rswag-ui'
 

cspell.json

@@ -21,6 +21,7 @@
     "appuser",
     "autoload",
     "autoloadable",
+    "BOOKOFGREG",
     "byebug",
     "cacher",
     "codegen",
@@ -42,6 +43,8 @@
     "rdoc",
     "rdoctask",
     "rswag",
+    "rubygems",
+    "RUBYGEMS",
     "srand",
     "scrollbars",
     "stylesheet",

rswag-api/lib/generators/rswag/api/install/templates/rswag_api.rb

@@ -4,11 +4,11 @@
   # This is used by the Swagger middleware to serve requests for API descriptions
   # NOTE: If you're using rswag-specs to generate Swagger, you'll need to ensure
   # that it's configured to generate files in the same folder
-  c.openapi_root = Rails.root.to_s + '/swagger'
+  c.openapi_root = Rails.root.to_s + '/openapi'
 
-  # Inject a lambda function to alter the returned Swagger prior to serialization
+  # Inject a lambda function to alter the returned OpenAPI prior to serialization
   # The function will have access to the rack env for the current request
   # For example, you could leverage this to dynamically assign the "host" property
   #
-  #c.swagger_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
+  #c.openapi_filter = lambda { |swagger, env| swagger['host'] = env['HTTP_HOST'] }
 end

rswag-api/lib/rswag/api.rb

@@ -4,34 +4,12 @@
 
 module Rswag
   module Api
-    RENAMED_METHODS = {
-      swagger_root: :openapi_root
-    }.freeze
-    private_constant :RENAMED_METHODS
-
     def self.configure
       yield(config)
     end
 
     def self.config
       @config ||= Configuration.new
     end
-
-    def self.deprecator
-      @deprecator ||= ActiveSupport::Deprecation.new('3.0', 'rswag-api')
-    end
-
-    Configuration.class_eval do
-      RENAMED_METHODS.each do |old_name, new_name|
-        define_method("#{old_name}=") do |*args, &block|
-          public_send("#{new_name}=", *args, &block)
-        end
-      end
-    end
-
-    Api.deprecator.deprecate_methods(
-      Configuration,
-      RENAMED_METHODS.to_h { |old_name, new_name| ["#{old_name}=".to_sym, "#{new_name}=".to_sym] }
-    )
   end
 end

rswag-api/lib/rswag/api/configuration.rb

@@ -1,18 +1,10 @@
 module Rswag
   module Api
     class Configuration
-      attr_accessor :openapi_root, :swagger_filter, :swagger_headers
+      attr_accessor :openapi_root, :openapi_filter, :openapi_headers
 
       def resolve_openapi_root(env)
         path_params = env['action_dispatch.request.path_parameters'] || {}
-
-        if path_params.key?(:swagger_root)
-          Rswag::Api.deprecator.warn(
-            'swagger_root is deprecated and will be removed from rswag-api 3.0 (use openapi_root instead)'
-          )
-          return path_params[:swagger_root]
-        end
-
         path_params[:openapi_root] || openapi_root
       end
     end

rswag-api/lib/rswag/api/middleware.rb

@@ -19,11 +19,11 @@ def call(env)
         return @app.call(env) unless filename.start_with? openapi_root.to_s
 
         if env['REQUEST_METHOD'] == 'GET' && File.file?(filename)
-          swagger = parse_file(filename)
-          @config.swagger_filter.call(swagger, env) unless @config.swagger_filter.nil?
+          openapi = parse_file(filename)
+          @config.openapi_filter.call(openapi, env) unless @config.openapi_filter.nil?
           mime = Rack::Mime.mime_type(::File.extname(path), 'text/plain')
-          headers = { 'Content-Type' => mime }.merge(@config.swagger_headers || {})
-          body = unload_swagger(filename, swagger)
+          headers = { 'Content-Type' => mime }.merge(@config.openapi_headers || {})
+          body = unload_openapi(filename, openapi)
 
           return [
             '200',
@@ -53,11 +53,11 @@ def load_json(filename)
         JSON.parse(File.read(filename))
       end
 
-      def unload_swagger(filename, swagger)
+      def unload_openapi(filename, openapi)
         if /\.ya?ml$/ === filename
-          YAML.dump(swagger)
+          YAML.dump(openapi)
         else
-          JSON.dump(swagger)
+          JSON.dump(openapi)
         end
       end
     end

rswag-api/spec/lib/rswag/api/configuration_spec.rb

@@ -4,17 +4,4 @@
 
 RSpec.describe Rswag::Api::Configuration do
   subject(:configuration) { described_class.new }
-
-  describe '#swagger_root=' do
-    it 'is deprecated' do
-      allow(Rswag::Api.deprecator).to receive(:warn)
-      configuration.swagger_root = 'foobar'
-      expect(subject.openapi_root).to eq('foobar')
-      expect(Rswag::Api.deprecator).to(
-        have_received(:warn)
-          .with('swagger_root= is deprecated and will be removed from rswag-api 3.0 (use openapi_root= instead)',
-                any_args)
-      )
-    end
-  end
 end

rswag-api/spec/rswag/api/fixtures/openapi/v1/openapi.yml

@@ -0,0 +1,12 @@
+openapi: 3.0.0
+info:
+  version: 1.0.0
+  title: API V1
+  description: A sample API to illustrate OpenAPI concepts
+paths:
+  /list:
+    get:
+      description: Returns a list of stuff
+      responses:
+        '200':
+          description: Successful response