openapi-ruby 2.6.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 624a9de17a27fc482cf818dde3e816f4a4117f75abe79360acc21ebf6adc3c94
-  data.tar.gz: f886aa70bf6d15d26a88ed99abda4a7440eb6d3f8304a6759896e28e6dfeb137
+  metadata.gz: d33ec2601c1341f8afb455e3b2f0f1daa594aa96ddf3daebb8b6c6675a1f3723
+  data.tar.gz: 44827b7a0f446ed51c1de676b8e777437ccfe8408b7166b731f1b55842b96fb2
 SHA512:
-  metadata.gz: 54139198ea02942afe69bce8b677bd582ea60e303aece0cbca150b04583a2bc5688f8a56e3dafbf6d2ee4cba87d10396fff54996956d8ad77ab4db109a849fd6
-  data.tar.gz: 31489283c2805df247155d08ce89575015342429a3d507c5b44549a09baa853646ede82288ca5ecc443d660bcfa93a34036e58fdc872757688471a2e07d804fe
+  metadata.gz: 5d52dce6834c33e78cd9b8666291b35c289da0981eba2cadfad5c48b10d63a45c65a8d7e959dc09438ec64b9883e0a15ccea96af1c955892901096e0f1172075
+  data.tar.gz: 6c99f505c721c19bc5be989f4d6d0b0e4a5f7dfe794d688286040b89fd5146dc3aa73ef1c2fbe65fc418785644686bf4d65bf23c98185ddc5814e244f8d1b7b0

data/README.md

@@ -5,14 +5,14 @@
 <h1 align="center">openapi_ruby</h1>
 
 <p align="center">
-  A unified OpenAPI 3.1 toolkit for Rails that combines test-driven spec generation, reusable schema components as Ruby classes, and runtime request/response validation middleware. Works with both RSpec and Minitest.
+  A unified OpenAPI toolkit for Rails that combines test-driven spec generation, reusable schema components as Ruby classes, and runtime request/response validation middleware. Supports OpenAPI 3.0 and 3.1. Works with both RSpec and Minitest.
 </p>
 
 Replaces [rswag](https://github.com/rswag/rswag), [rswag-schema-components](https://github.com/101skills-gmbh/rswag-schema-components), and [committee](https://github.com/interagent/committee) with a single gem.
 
 ## Key Features
 
-- **OpenAPI 3.1** with JSON Schema 2020-12 (via [json_schemer](https://github.com/davishmcclurg/json_schemer))
+- **OpenAPI 3.0 & 3.1** with JSON Schema 2020-12 (via [json_schemer](https://github.com/davishmcclurg/json_schemer))
 - **Test-framework agnostic** — works with RSpec and Minitest
 - **Schema components** as Ruby classes with inheritance
 - **Runtime middleware** for request/response validation with deep type checking
@@ -74,6 +74,45 @@ OpenapiRuby.configure do |config|
 end
 ```
 
+### OpenAPI Version
+
+The default OpenAPI version is 3.1.0. To generate 3.0.x schemas (e.g., when using `nullable: true`):
+
+```ruby
+config.schemas = {
+  public_api: {
+    openapi_version: "3.0.3",
+    info: { title: "My API", version: "v1" },
+    servers: [{ url: "/" }]
+  }
+}
+```
+
+### Multiple Schemas with Scopes
+
+For projects with multiple APIs, use `component_scope` to partition components:
+
+```ruby
+config.schemas = {
+  "internal/v1/schema": {
+    info: { title: "Internal API", version: "v1" },
+    component_scope: :internal_v1
+  },
+  "public/v2/schema": {
+    info: { title: "Public API", version: "v2" },
+    component_scope: :public_v2
+  }
+}
+
+# Infer scopes from directory structure (e.g., internal/v1/schemas/user.rb → :internal_v1)
+config.component_scope_paths = {
+  "internal/v1" => :internal_v1,
+  "public/v2" => :public_v2
+}
+```
+
+Components are automatically scoped based on their file path. Use `shared_component` to include a component in all schemas, or `component_scopes :scope1, :scope2` to assign explicitly.
+
 ## Schema Components
 
 Define your API schemas as Ruby classes:
@@ -334,13 +373,15 @@ end
 
 ## Spec Generation
 
-Generate OpenAPI spec files after running tests:
+Generate OpenAPI spec files without running tests:
 
 ```bash
 rake openapi_ruby:generate
 ```
 
-Or automatically after the test suite via the `after(:suite)` / `Minitest.after_run` hooks (enabled by default).
+This uses RSpec `--dry-run` (or loads Minitest files) to collect API definitions and write schemas. It auto-detects the test framework, or you can set `FRAMEWORK=rspec` or `FRAMEWORK=minitest`. Custom patterns: `PATTERN="packs/*/spec/**/*_spec.rb"`.
+
+Schemas are also generated automatically after running the full test suite via `after(:suite)` / `Minitest.after_run` hooks.
 
 ## Runtime Middleware
 

data/lib/openapi_ruby/adapters/minitest.rb

@@ -191,11 +191,10 @@ module OpenapiRuby
       end
 
       def self.install!
-        ::Minitest.after_run do
-          OpenapiRuby::Generator::SchemaWriter.generate_all!
-        rescue => e
-          warn "[openapi_ruby] Schema generation failed: #{e.message}"
-        end
+        # Schema writing is handled by the rake task (openapi_ruby:generate),
+        # not by test runs. The rake task loads test files to register DSL
+        # contexts, then calls SchemaWriter.generate_all! directly.
+        # This prevents partial schema overwrites when running a subset of tests.
       end
     end
   end

data/lib/openapi_ruby/adapters/rspec.rb

@@ -278,22 +278,10 @@ module OpenapiRuby
             config.include ::RSpec::Rails::RequestExampleGroup, type: :openapi
           end
 
-          config.after(:suite) do
-            OpenapiRuby::Generator::SchemaWriter.generate_all!
-          rescue => e
-            warn "[openapi_ruby] Schema generation failed: #{e.message}"
-          end
-
-          # RSpec's --dry-run mode does not fire after(:suite) hooks.
-          # Describe/context blocks are still evaluated (registering DSL contexts),
-          # but the hook that writes schemas never runs. Use at_exit as a fallback.
-          if config.dry_run?
-            at_exit do
-              OpenapiRuby::Generator::SchemaWriter.generate_all!
-            rescue => e
-              warn "[openapi_ruby] Schema generation failed: #{e.message}"
-            end
-          end
+          # Schema writing is handled by the rake task (openapi_ruby:generate),
+          # not by test runs. The rake task loads spec files to register DSL
+          # contexts, then calls SchemaWriter.generate_all! directly.
+          # This prevents partial schema overwrites when running a subset of specs.
         end
       end
     end

data/lib/openapi_ruby/core/document.rb

@@ -28,7 +28,7 @@ module OpenapiRuby
       end
 
       def set_security(security)
-        @data["security"] = security if security.any?
+        @data["security"] = security
       end
 
       def set_tags(tags)

data/lib/openapi_ruby/dsl/context.rb

@@ -34,8 +34,8 @@ module OpenapiRuby
       def to_openapi
         result = {}
 
-        result["parameters"] = @path_parameters if @path_parameters.any?
-
+        # Path-level parameters are already copied into each operation (line 27),
+        # so we don't output them at the path level to avoid duplicates.
         @operations.each do |verb, op|
           result[verb] = op.to_openapi
         end

data/lib/openapi_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiRuby
-  VERSION = "2.6.0"
+  VERSION = "3.0.0"
 end

data/lib/tasks/openapi_ruby.rake

@@ -28,9 +28,27 @@ end
 
 def generate_with_rspec
   pattern = ENV.fetch("PATTERN", "spec/**/*_spec.rb")
-  command = "bundle exec rspec --pattern '#{pattern}' --dry-run --order defined"
   puts "Generating OpenAPI schemas (RSpec)..."
-  system(command) || abort("Schema generation failed")
+
+  # Load rspec-core first — normally RSpec's runner does this before spec_helper,
+  # but since we're loading specs via require we need it explicitly.
+  require "rspec/core"
+
+  # Add spec/ to the load path so require "openapi_helper" / "rails_helper" works,
+  # matching what RSpec does when it runs.
+  $LOAD_PATH.unshift(File.expand_path("spec")) unless $LOAD_PATH.include?(File.expand_path("spec"))
+
+  # Load all spec files to trigger DSL context registrations.
+  # RSpec's describe/context blocks are evaluated at load time,
+  # so requiring the files registers paths and operations without
+  # running any tests. Spec files pull in RSpec and the openapi_ruby
+  # adapter via their own require chains (e.g. require "openapi_helper").
+  pattern.split(",").each do |p|
+    Dir.glob(p.strip).each { |f| require File.expand_path(f) }
+  end
+
+  # Generate schemas from the registered contexts
+  OpenapiRuby::Generator::SchemaWriter.generate_all!
 end
 
 def generate_with_minitest

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Morten Hartvig
@@ -65,9 +65,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
-description: A unified OpenAPI 3.1 toolkit for Rails that combines test-driven spec
-  generation, reusable schema components as Ruby classes, and runtime request/response
-  validation middleware. Works with both RSpec and Minitest.
+description: A unified OpenAPI toolkit for Rails that combines test-driven spec generation,
+  reusable schema components as Ruby classes, and runtime request/response validation
+  middleware. Supports OpenAPI 3.0 and 3.1. Works with both RSpec and Minitest.
 email:
 - morten@hartvigsen.dev
 executables: []
@@ -144,6 +144,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: OpenAPI 3.1 toolkit for Rails — spec generation, schema components, and runtime
-  validation
+summary: OpenAPI 3.0/3.1 toolkit for Rails — spec generation, schema components, and
+  runtime validation
 test_files: []