openapi-ruby 3.5.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 936888de957c1f2de331027e22f12edc490b3a49e4a71cac9aaafcf085f251db
-  data.tar.gz: 143efa7749ecb7292f52309ee80c3fa7663ccf2cb20387a81fe34d62319181ae
+  metadata.gz: b7cf0386d71aab389accfc260a830ee4c5f58260afca19e6a4849163f6aa6661
+  data.tar.gz: 904d32c7314c46e68cda32d12740194bda8d25ca0cf177f0a8f4812a6f2e13a7
 SHA512:
-  metadata.gz: e8d35b9315e7d357f32704ae303721be1dee960d0d4be01ba1f3ea4939cd2658177480c9e1a70b76909743ad130eabdb02e64f825543df840f1e4e7678ab1bad
-  data.tar.gz: 1e8ee130cc36c66a5e259e65afda71753c7dbd4a63cab4d6441fd6706c55da429dbafc2723e292f6412d92a4ab072017c69789ed206b875c9f7783b54720147d
+  metadata.gz: 38ca153a668606b62a97ea58fb6d74ca0ff95f073e6bbc0dbff831338b9f6bbc79887dbda977bd2daff045fd071d5f4b714beeedf8c5b90440f7f0db54814574
+  data.tar.gz: 6239cdcd0dbff05e9f62a6098337e8f675d42ca852c865da755a3f1c4babe031e31eb33f3cde34e28dd9be0f44d392c4c757ce36933ca43a62df74cf19012dcf

data/README.md

@@ -44,7 +44,7 @@ This creates:
 - `config/initializers/openapi_ruby.rb` — configuration
 - `spec/openapi_helper.rb` or `test/openapi_helper.rb` — test helper
 - `app/api_components/` — directory for schema components
-- `swagger/` — output directory for generated specs
+- `openapi/` — output directory for generated specs
 - Engine mount in `config/routes.rb`
 
 ## Configuration
@@ -61,7 +61,7 @@ OpenapiRuby.configure do |config|
 
   config.component_paths = ["app/api_components"]
   config.camelize_keys = true
-  config.schema_output_dir = "swagger"
+  config.schema_output_dir = "openapi"
   config.schema_output_format = :yaml
 
   # Runtime middleware (disabled by default)
@@ -72,8 +72,6 @@ OpenapiRuby.configure do |config|
   # Enabled by default; set to false to disable.
   config.test_request_validation = true
 
-  # Optional Swagger UI (disabled by default)
-  config.ui_enabled = false
 end
 ```
 
@@ -532,23 +530,25 @@ config.schemas = {
 
 ## Swagger UI
 
-Enable optional Swagger UI:
+Mount the engine to expose the schema endpoints:
 
 ```ruby
-OpenapiRuby.configure do |config|
-  config.ui_enabled = true
-end
+# config/routes.rb
+mount OpenapiRuby::Engine => "/api-docs"
 ```
 
-Visit `/api-docs/ui` to see your API documentation. Schema files are served at `/api-docs/schemas/:name`.
+Schema files are served at `/api-docs/schemas/:name`.
 
-## Engine Routes
+To also serve the interactive Swagger UI at the mount root, opt in:
 
 ```ruby
-# config/routes.rb
-mount OpenapiRuby::Engine => "/api-docs"
+OpenapiRuby.configure do |config|
+  config.ui_enabled = true
+end
 ```
 
+Then visit `/api-docs` for the UI. When `ui_enabled` is `false` (the default), `/api-docs` returns 404 and only the schema endpoints are served — useful when downstream tooling needs the schema but you don't want to expose an interactive explorer.
+
 ## License
 
 MIT

data/app/controllers/openapi_ruby/ui_controller.rb

@@ -5,8 +5,6 @@ module OpenapiRuby
     layout false
 
     def index
-      return head :not_found unless OpenapiRuby.configuration.ui_enabled
-
       config = OpenapiRuby.configuration
       @schemas = config.schemas
       @ui_config = config.ui_config
@@ -15,8 +13,6 @@ module OpenapiRuby
     end
 
     def oauth2_redirect
-      return head :not_found unless OpenapiRuby.configuration.ui_enabled
-
       file = File.join(OpenapiRuby::Engine.root, "app", "views", "openapi_ruby", "oauth2_redirect.html")
       render file: file, layout: false, content_type: "text/html"
     end

data/config/routes.rb

@@ -4,6 +4,8 @@ OpenapiRuby::Engine.routes.draw do
   get "schemas", to: "schemas#index", as: :schemas
   get "schemas/*id", to: "schemas#show", as: :schema
 
-  get "ui", to: "ui#index", as: :ui
-  get "oauth2-redirect.html", to: "ui#oauth2_redirect", as: :oauth2_redirect
+  if OpenapiRuby.configuration.ui_enabled
+    root to: "ui#index"
+    get "oauth2-redirect.html", to: "ui#oauth2_redirect", as: :oauth2_redirect
+  end
 end

data/lib/generators/openapi_ruby/install/install_generator.rb

@@ -25,8 +25,8 @@ module OpenapiRuby
         empty_directory "app/api_components/security_schemes"
       end
 
-      def create_swagger_directory
-        empty_directory "swagger"
+      def create_schema_output_directory
+        empty_directory "openapi"
       end
 
       def mount_engine

data/lib/generators/openapi_ruby/install/templates/initializer.rb.tt

@@ -17,7 +17,7 @@ OpenapiRuby.configure do |config|
   config.camelize_keys = true
 
   # Generated schema output
-  config.schema_output_dir = "swagger"
+  config.schema_output_dir = "openapi"
   config.schema_output_format = :yaml
 
   # Runtime request/response validation middleware
@@ -25,7 +25,7 @@ OpenapiRuby.configure do |config|
   config.request_validation = :disabled
   config.response_validation = :disabled
 
-  # Swagger UI (optional, disabled by default)
+  # Swagger UI at the engine's mount path (disabled by default).
+  # When false, only the schema endpoints are served.
   config.ui_enabled = false
-  # config.ui_path = "/api-docs"
 end

data/lib/openapi_ruby/configuration.rb

@@ -40,7 +40,7 @@ module OpenapiRuby
     end
 
     # UI (optional)
-    attr_accessor :ui_enabled, :ui_path, :ui_config
+    attr_accessor :ui_enabled, :ui_config
 
     def initialize
       @schemas = {}
@@ -51,10 +51,9 @@ module OpenapiRuby
       @response_validation = :disabled
       @coerce_params = true
       @test_request_validation = true
-      @schema_output_dir = "swagger"
+      @schema_output_dir = "openapi"
       @schema_output_format = :yaml
       @ui_enabled = false
-      @ui_path = "/api-docs"
       @ui_config = {}
       @strict_reference_validation = :warn_only
       @auto_validation_error_response = true

data/lib/openapi_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Morten Hartvig