Merge pull request #148 from mercedesb/custom-summary-and-tags

README.md

@@ -169,6 +169,14 @@ EOS
 # Generate a custom description, given an RSpec example
 RSpec::OpenAPI.description_builder = -> (example) { example.description }
 
+# Generate a custom summary, given an RSpec example
+# This example uses the summary from the example_group.
+RSpec::OpenAPI.summary_builder = ->(example) { example.metadata.dig(:example_group, :openapi, :summary) }
+
+# Generate a custom tags, given an RSpec example
+# This example uses the tags from the parent_example_group
+RSpec::OpenAPI.tags_builder = -> (example) { example.metadata.dig(:example_group, :parent_example_group, :openapi, :tags) }
+
 # Change the example type(s) that will generate schema
 RSpec::OpenAPI.example_types = %i[request]
 

lib/rspec/openapi.rb

@@ -19,6 +19,8 @@ module RSpec::OpenAPI
   @comment = nil
   @enable_example = true
   @description_builder = ->(example) { example.description }
+  @summary_builder = ->(example) { example.metadata[:summary] }
+  @tags_builder = ->(example) { example.metadata[:tags] }
   @info = {}
   @application_version = '1.0.0'
   @request_headers = []
@@ -35,6 +37,8 @@ class << self
                   :comment,
                   :enable_example,
                   :description_builder,
+                  :summary_builder,
+                  :tags_builder,
                   :info,
                   :application_version,
                   :request_headers,

lib/rspec/openapi/record_builder.rb

@@ -62,8 +62,8 @@ def extract_headers(request, response)
 
   def extract_request_attributes(request, example)
     metadata = example.metadata[:openapi] || {}
-    summary = metadata[:summary]
-    tags = metadata[:tags]
+    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
+    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
     operation_id = metadata[:operation_id]
     required_request_params = metadata[:required_request_params] || []
     security = metadata[:security]