Introduce Post-Processing Hook for OpenAPI Spec Customization (#206)

README.md

@@ -190,6 +190,13 @@ RSpec::OpenAPI.ignored_path_params = %i[controller action format]
 # In that case, you can specify the paths to ignore.
 # String or Regexp is acceptable.
 RSpec::OpenAPI.ignored_paths = ["/admin/full/path/", Regexp.new("^/_internal/")]
+
+# Your custom post-processing hook (like unrandomizing IDs)
+RSpec::OpenAPI.post_process_hook = -> (path, records, spec) do
+  RSpec::OpenAPI::HashHelper.matched_paths(spec, 'paths.*.*.responses.*.content.*.*.*.id').each do |paths|
+    spec.dig(*paths[0..-2]).merge!(id: '123')
+  end
+end
 ```
 
 ### Can I use rspec-openapi with `$ref` to minimize duplication of schema?

lib/rspec/openapi.rb

@@ -33,6 +33,7 @@ module RSpec::OpenAPI
   @path_records = Hash.new { |h, k| h[k] = [] }
   @ignored_path_params = %i[controller action format]
   @ignored_paths = []
+  @post_process_hook = nil
 
   # This is the configuraion override file name we look for within each path.
   @config_filename = 'rspec_openapi.rb'
@@ -54,7 +55,8 @@ class << self
                   :response_headers,
                   :path_records,
                   :ignored_paths,
-                  :ignored_path_params
+                  :ignored_path_params,
+                  :post_process_hook
 
     attr_reader   :config_filename
   end

lib/rspec/openapi/result_recorder.rb

@@ -29,11 +29,8 @@ def record_results!
         rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
           @error_records[e] = record # Avoid failing the build
         end
-        RSpec::OpenAPI::SchemaCleaner.cleanup_conflicting_security_parameters!(spec)
-        RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
-        RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
-        RSpec::OpenAPI::SchemaCleaner.cleanup_empty_required_array!(spec)
-        RSpec::OpenAPI::SchemaSorter.deep_sort!(spec)
+        cleanup_schema!(new_from_zero, spec)
+        execute_post_process_hook(path, records, spec)
       end
     end
   end
@@ -49,4 +46,18 @@ def error_message
       #{@error_records.map { |e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
     ERR_MSG
   end
+
+  private
+
+  def execute_post_process_hook(path, records, spec)
+    RSpec::OpenAPI.post_process_hook.call(path, records, spec) if RSpec::OpenAPI.post_process_hook.is_a?(Proc)
+  end
+
+  def cleanup_schema!(new_from_zero, spec)
+    RSpec::OpenAPI::SchemaCleaner.cleanup_conflicting_security_parameters!(spec)
+    RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
+    RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
+    RSpec::OpenAPI::SchemaCleaner.cleanup_empty_required_array!(spec)
+    RSpec::OpenAPI::SchemaSorter.deep_sort!(spec)
+  end
 end

spec/apps/rails/doc/openapi.json

@@ -1139,5 +1139,6 @@
         "name": "Secret-Key"
       }
     }
-  }
+  },
+  "custom_field": "custom_value"
 }

spec/apps/rails/doc/openapi.yaml

@@ -742,3 +742,4 @@ components:
       type: apiKey
       in: header
       name: Secret-Key
+custom_field: custom_value

spec/integration_tests/rails_test.rb

@@ -34,6 +34,8 @@
   },
 }
 
+RSpec::OpenAPI.post_process_hook = ->(_path, _records, spec) { spec['custom_field'] = 'custom_value' }
+
 class TablesIndexTest < ActionDispatch::IntegrationTest
   i_suck_and_my_tests_are_order_dependent!
   openapi!