rspec-openapi 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71067082bcf502d2e38341d6c357ee596851cefa9ff4e95b4ac34249261782df
-  data.tar.gz: '03279a96e39df1126d9fac2858903382654d2daa3121d415cf163b0bb1117fd1'
+  metadata.gz: 3032d3fed3b9bdc2b2a8512db3d1645679163539106650c1ad05069a15ab59cd
+  data.tar.gz: d1d3e85b467226a857b30bfe95b5643a1a37df2c0a925e509bdd893ae3017177
 SHA512:
-  metadata.gz: 8a3344f5ee11410e189661e1ec4a6e39ab9775e2554a9a7c92818bfee71de670ec606539ccb71f60da70b727b1e8d65366507640496947e181e2bbe25251dbe2
-  data.tar.gz: e332d6b082d4d6215535e90b750afaf2228310f989916f7b4d1b770c972ef055f329b0c84f37dba070719b4bbee7fcb47ec7d3f0c422af66b4bd712493b51e46
+  metadata.gz: 0c65c74db1ada24cf360545bda34830ca82d9cbd11b6e862a0563f9fc2bf244d65a96ec74e8223c182d1a2bff72b237e30c5884c2818576f9c142585d177351b
+  data.tar.gz: 397cfcddeaf3c1f683b9a1cd75960bf7d61e24adfcc9988bea2533c7a781acd42f43178b2ffb45deb5b3e821090f979d18af041a078f9ca3c2c7cd124cb4aff2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v0.4.1
+
+* Add `RSpec::OpenAPI.example_types` to hook types other than `type: :request`.
+  [#32](https://github.com/k0kubun/rspec-openapi/pull/32)
+
 ## v0.4.0
 
 * Drop `RSpec::OpenAPI.output` introduced in v0.3.20

data/README.md

@@ -135,6 +135,9 @@ EOS
 
 # Generate a custom description, given an RSpec example
 RSpec::OpenAPI.description_builder = -> (example) { example.description }
+
+# Change the example type(s) that will generate schema
+RSpec::OpenAPI.example_types = %i[request]
 ```
 
 ### How can I add information which can't be generated from RSpec?

data/lib/rspec/openapi/hooks.rb

@@ -9,7 +9,7 @@ records = []
 records_errors = []
 
 RSpec.configuration.after(:each) do |example|
-  if example.metadata[:type] == :request && example.metadata[:openapi] != false
+  if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
     record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
     records << record if record
   end
@@ -31,7 +31,7 @@ RSpec.configuration.after(:suite) do
   if records_errors.any?
     error_message = <<~EOS
       RSpec::OpenAPI got errors building #{records_errors.size} requests
-      
+
       #{records_errors.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
     EOS
     colorizer = ::RSpec::Core::Formatters::ConsoleCodes

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

data/lib/rspec/openapi.rb

@@ -9,8 +9,9 @@ module RSpec::OpenAPI
   @application_version = '1.0.0'
   @request_headers = []
   @server_urls = []
+  @example_types = %i[request]
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls, :example_types
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2021-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack