Merge pull request #155 from exoego/sort-paths

Sort paths lexicographically so the order of paths is more stable and predictable
exoego · Dec 6, 2023 · de5106c · de5106c
2 parents 7ea88d2 + d10c469
commit de5106c
Show file tree

Hide file tree

Showing 4 changed files with 748 additions and 740 deletions.
diff --git a/lib/rspec/openapi/result_recorder.rb b/lib/rspec/openapi/result_recorder.rb
@@ -26,6 +26,7 @@ def record_results!
         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::SchemaCleaner.sort_paths!(spec)
       end
     end
   end

diff --git a/lib/rspec/openapi/schema_cleaner.rb b/lib/rspec/openapi/schema_cleaner.rb
@@ -51,6 +51,13 @@ def cleanup_empty_required_array!(base)
     end
   end
 
+  # Sort "paths" lexicographically to make the order more predictable
+  #
+  # @param [Hash]   #
+  def sort_paths!(spec)
+    spec['paths'] = spec['paths']&.entries&.sort_by! { |path, _| path }.to_h
+  end
+
   private
 
   def cleanup_array!(base, spec, selector, fields_for_identity = [])