Merge pull request #153 from exoego/add-custom-title

Add custom title via RSpec::OpenAPI.title
exoego · Dec 1, 2023 · c8ff1da · c8ff1da
2 parents 7804e0f + 2397ee0
commit c8ff1da
Show file tree

Hide file tree

Showing 11 changed files with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,8 @@ RSpec::OpenAPI.path = -> (example) {
   end
 }
 
+RSpec::OpenAPI.title = 'OpenAPI Documentation'
+
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 

diff --git a/lib/rspec/openapi.rb b/lib/rspec/openapi.rb
@@ -15,6 +15,7 @@
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
+  @title = File.basename(Dir.pwd)
   @comment = nil
   @enable_example = true
   @description_builder = ->(example) { example.description }
@@ -30,6 +31,7 @@ module RSpec::OpenAPI
 
   class << self
     attr_accessor :path,
+                  :title,
                   :comment,
                   :enable_example,
                   :description_builder,

diff --git a/lib/rspec/openapi/result_recorder.rb b/lib/rspec/openapi/result_recorder.rb
@@ -7,7 +7,7 @@ def initialize(path_records)
   end
 
   def record_results!
-    title = File.basename(Dir.pwd)
+    title = RSpec::OpenAPI.title
     @path_records.each do |path, records|
       RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
         schema = RSpec::OpenAPI::DefaultSchema.build(title)

diff --git a/spec/integration_tests/rails_test.rb b/spec/integration_tests/rails_test.rb
@@ -7,6 +7,7 @@
 require 'minitest/autorun'
 require File.expand_path('../rails/config/environment', __dir__)
 
+RSpec::OpenAPI.title = 'OpenAPI Documentation'
 RSpec::OpenAPI.request_headers = %w[X-Authorization-Token]
 RSpec::OpenAPI.response_headers = %w[X-Cursor]
 RSpec::OpenAPI.path = File.expand_path("../rails/doc/openapi.#{ENV.fetch('OPENAPI_OUTPUT', nil)}", __dir__)

diff --git a/spec/integration_tests/roda_test.rb b/spec/integration_tests/roda_test.rb
@@ -8,6 +8,7 @@
 
 ENV['OPENAPI_OUTPUT'] ||= 'yaml'
 
+RSpec::OpenAPI.title = 'OpenAPI Documentation'
 RSpec::OpenAPI.path = File.expand_path("../roda/doc/openapi.#{ENV.fetch('OPENAPI_OUTPUT', nil)}", __dir__)
 
 class RodaTest < Minitest::Test

diff --git a/spec/rails/doc/openapi.json b/spec/rails/doc/openapi.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "title": "rspec-openapi",
+    "title": "OpenAPI Documentation",
     "version": "1.0.0",
     "description": "My beautiful API",
     "license": {

diff --git a/spec/rails/doc/openapi.yaml b/spec/rails/doc/openapi.yaml
@@ -5,7 +5,7 @@
 ---
 openapi: 3.0.3
 info:
-  title: rspec-openapi
+  title: OpenAPI Documentation
   version: 1.0.0
   description: My beautiful API
   license:

diff --git a/spec/requests/rails_spec.rb b/spec/requests/rails_spec.rb
@@ -7,6 +7,7 @@
 require File.expand_path('../rails/config/environment', __dir__)
 require 'rspec/rails'
 
+RSpec::OpenAPI.title = 'OpenAPI Documentation'
 RSpec::OpenAPI.request_headers = %w[X-Authorization-Token]
 RSpec::OpenAPI.response_headers = %w[X-Cursor]
 RSpec::OpenAPI.path = File.expand_path("../rails/doc/openapi.#{ENV.fetch('OPENAPI_OUTPUT', nil)}", __dir__)

diff --git a/spec/requests/roda_spec.rb b/spec/requests/roda_spec.rb
@@ -6,6 +6,7 @@
 
 ENV['OPENAPI_OUTPUT'] ||= 'yaml'
 
+RSpec::OpenAPI.title = 'OpenAPI Documentation'
 RSpec::OpenAPI.path = File.expand_path("../roda/doc/openapi.#{ENV.fetch('OPENAPI_OUTPUT', nil)}", __dir__)
 
 RSpec::OpenAPI.description_builder = lambda do |example|

diff --git a/spec/roda/doc/openapi.json b/spec/roda/doc/openapi.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "title": "rspec-openapi",
+    "title": "OpenAPI Documentation",
     "version": "1.0.0"
   },
   "servers": [

diff --git a/spec/roda/doc/openapi.yaml b/spec/roda/doc/openapi.yaml
@@ -1,7 +1,7 @@
 ---
 openapi: 3.0.3
 info:
-  title: rspec-openapi
+  title: OpenAPI Documentation
   version: 1.0.0
 servers: []
 paths: