pact_broker 2.107.1 → 2.108.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 847d116937c44be25268cb31141093ab8c90e587d6e7bb304357116c6792ba23
-  data.tar.gz: 12d14a0de3a15cd7efbbd035add102c338ee4347a0cf6490778a4644f69f2c44
+  metadata.gz: 79ce9d64a823a800533d3312f75b9e008d621833683e1f1424827fdf146ae855
+  data.tar.gz: 46c802480921553348daf0f3db5af2cbd94dd0a3b40de7db29f7137846768b93
 SHA512:
-  metadata.gz: 34d62e70671d6ac6e4e26bb967c9e76279358a8e75db804c0ef0fd16790f82ee8b1095de841cdf730ff6b222faf01ade5993cf693631802628e9da2791ea7a1f
-  data.tar.gz: 014ee6deb6bdd2ad204e3ac8dd401e0cf2de755b12006b8fdd5bd33fb4e4ede5386b18a21d99b03d39c8f3552c40a55c709ba1ab7a7d0e6977bd922c827957f8
+  metadata.gz: 2fc7c186cd8b1174668c97724e9065bf417768ec854726d3651a1ad1c13908adaa6ad36979f17be05483208fab304dad25f19dc8e31c085c685fc73c9539192e
+  data.tar.gz: bbb31b5fde13172358084bd35e3d52161a4440f91c2363ed337f7aa5512e8669cc39a323ae7f970016924a669de4eedb35d891a3ce95cadea850032a97c995dd

data/CHANGELOG.md

@@ -1,3 +1,58 @@
+<a name="v2.108.0"></a>
+### v2.108.0 (2024-01-05)
+
+#### Features
+
+* bulk delete branches (#652)	 ([14ac33c8](/../../commit/14ac33c8))
+* add latest version for branch endpoint (#644)	 ([c216bec8](/../../commit/c216bec8))
+* add no-cache header	 ([9a637327](/../../commit/9a637327))
+* suppport `page` + `size` as pagination params (#642)	 ([c71089fe](/../../commit/c71089fe))
+* do not include pb:record-deployment or pb:record-release relations for versions embedded in resources	 ([2f43590c](/../../commit/2f43590c))
+* remove status from individual error in problem+error response	 ([a4b3ec58](/../../commit/a4b3ec58))
+* add version_id indexes to deployed_versions and released_versions	 ([00fc7d10](/../../commit/00fc7d10))
+* add endpoint to list branches for a pacticipant (#638)	 ([ff7e3a53](/../../commit/ff7e3a53))
+* stop running tests for ruby 2.7	 ([034aba3b](/../../commit/034aba3b))
+* update sinatra and rack-protection to ~> 3.0	 ([92ebbdd3](/../../commit/92ebbdd3))
+* add branch endpoint supporting GET and DELETE (#635)	 ([1bb6088d](/../../commit/1bb6088d))
+* optimise matrix by applying specified limit to pact publications before joining to verifications	 ([c61c324e](/../../commit/c61c324e))
+* optimise matrix query when selectors with pacticipant names only are used	 ([b98f5d1a](/../../commit/b98f5d1a))
+* include environment name in pact metadata	 ([e120c4e7](/../../commit/e120c4e7))
+* improve wording of 'no version exits' messaging in can-i-deploy response	 ([9529c679](/../../commit/9529c679))
+* improve performance of matrix when multiple selectors are specified (#631)	 ([58a28604](/../../commit/58a28604))
+* add pagination parameter validation for paginated endpoints. (#626)	 ([abb0a1c6](/../../commit/abb0a1c6))
+* add endpoint to list pacticipant versions by branch	 ([9b4e3f61](/../../commit/9b4e3f61))
+* add endpoint to return latest pact for consumer, provider and consumer branch	 ([f77086ef](/../../commit/f77086ef))
+* update required ruby version from 2.2 to 2.7	 ([f1b1e906](/../../commit/f1b1e906))
+* add pagination and filtering for integrations endpoint	 ([68d7cf30](/../../commit/68d7cf30))
+* add contract_data_updated_at to integrations table to speed up dashboard query (#617)	 ([e43c10f2](/../../commit/e43c10f2))
+* support setting feature toggles via individual environment variables (#609)	 ([be7d9d52](/../../commit/be7d9d52))
+
+* **metrics**
+  * hardcode matrix count to -1 as calculating it causes performance issues and it has no meaning	 ([62e121b8](/../../commit/62e121b8))
+
+* **matrix**
+  * optimise identification of the 'latest tag'	 ([824c516a](/../../commit/824c516a))
+
+#### Bug Fixes
+
+* **metrics**
+  * correct the query for pactRevisionsPerConsumerVersion	 ([f76b9935](/../../commit/f76b9935))
+
+* fix performance issues due to contention in the integrations table when publishing a large number of contracts (> 20) per request, in parallel (#654)	 ([321a2291](/../../commit/321a2291))
+* raise 404 on paths with missing path segments (#648)	 ([930b45cd](/../../commit/930b45cd))
+* do not error when no environment is found by name	 ([d1501618](/../../commit/d1501618))
+* ensure pact associations are eager loaded when finding a single pact	 ([c98abda6](/../../commit/c98abda6))
+* gracefully handle validating an array when a hash is expected	 ([b26ddb46](/../../commit/b26ddb46))
+* fix error occuring when can-i-deploy badge is requested and no version is found	 ([db7dee3a](/../../commit/db7dee3a))
+* fix bug in error handling for 'can-i-deploy branch to environment' badge	 ([c23beb6b](/../../commit/c23beb6b))
+* improve performance of network diagram (#614)	 ([ffd3ec4b](/../../commit/ffd3ec4b))
+* fix error raised when attempting to log warning when webhook_redact_sensitive_data is set to false	 ([9b66270e](/../../commit/9b66270e))
+* gracefully handle execution of webhooks that are deleted between execution attempts (#613)	 ([1127b41f](/../../commit/1127b41f))
+* add extra validation to ensure parsed content is a hash when publishing pacts	 ([913e0a52](/../../commit/913e0a52))
+
+* **matrix**
+  * return only most recent row missing verification when latestby=cp	 ([b7550e53](/../../commit/b7550e53))
+
 <a name="v2.107.1"></a>
 ### v2.107.1 (2023-05-02)
 

data/Gemfile

@@ -34,14 +34,15 @@ group :test do
   gem "approvals", ">=0.0.24", "<1.0.0"
   gem "tzinfo", "~>2.0"
   gem "faraday-retry", "~>2.0"
+  gem "openapi_first", "~>0.20"
 end
 
-if ENV["INSTALL_MYSQL"] == "true"
-  gem "mysql2", "~>0.5"
+group :pg, optional: true do
+  gem "pg", "~>1.2"
 end
 
-if ENV["INSTALL_PG"] == "true"
-  gem "pg", "~>1.2"
+group :mysql, optional: true do
+  gem "mysql2", "~>0.5"
 end
 
 if ENV["X_PACT_DEVELOPMENT"] == "true"

data/README.md

@@ -188,3 +188,4 @@ The Pact Broker follows the [semantic versioning](https://semver.org/) scheme.
 [cli]: https://github.com/pact-foundation/pact-ruby-standalone/releases
 [travisyml]: https://github.com/pact-foundation/pact_broker/blob/master/.travis.yml
 [overview]: https://github.com/pact-foundation/pact_broker/wiki/Overview
+

data/db/migrations/20230615_add_integrations_contract_data_updated_at.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+  up do
+    alter_table(:integrations) do
+      add_column(:contract_data_updated_at, DateTime)
+    end
+  end
+
+  down do
+    alter_table(:integrations) do
+      drop_column(:contract_data_updated_at)
+    end
+  end
+end

data/db/migrations/20230616_set_integrations_contract_data_updated_at.rb

@@ -0,0 +1,11 @@
+require "pact_broker/db/data_migrations/set_contract_data_updated_at_for_integrations"
+
+Sequel.migration do
+  up do
+    PactBroker::DB::DataMigrations::SetContractDataUpdatedAtForIntegrations.call(self)
+  end
+
+  down do
+
+  end
+end

data/db/migrations/20231002_add_version_id_index_to_released_version.rb

@@ -0,0 +1,21 @@
+require_relative "migration_helper"
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:released_versions) do
+        add_index(:version_id, name: "released_versions_version_id_ndx")
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:released_versions) do
+        drop_index(:version_id, name: "released_versions_version_id_ndx")
+      end
+    end
+  end
+end

data/db/migrations/20231003_add_version_id_index_to_deployed_version.rb

@@ -0,0 +1,21 @@
+require_relative "migration_helper"
+
+include PactBroker::MigrationHelper
+
+Sequel.migration do
+  up do
+    if !mysql?
+      alter_table(:deployed_versions) do
+        add_index(:version_id, name: "deployed_versions_version_id_ndx")
+      end
+    end
+  end
+
+  down do
+    if !mysql?
+      alter_table(:deployed_versions) do
+        drop_index(:version_id, name: "deployed_versions_version_id_ndx")
+      end
+    end
+  end
+end

data/docs/CONFIGURATION.md

@@ -666,6 +666,16 @@ The maximum amount of time in seconds to attempt to generate the diff between tw
 **YAML configuration key name:** `pact_content_diff_timeout`<br/>
 **Default:** `15`<br/>
 
+### network_diagram_max_pacticipants
+
+The maximum number of pacticipants to include in the network diagram. When too many pacticipants are included, the diagram becomes unreadable,
+and at large numbers, the graph will not render due to browser performance issues.
+
+**Environment variable name:** `PACT_BROKER_NETWORK_DIAGRAM_MAX_PACTICIPANTS`<br/>
+**YAML configuration key name:** `network_diagram_max_pacticipants`<br/>
+**Default:** `150`<br/>
+**Allowed values:** A positive integer<br/>
+
 <br/>
 
 ## Miscellaneous

data/lib/pact_broker/api/contracts/base_contract.rb

@@ -22,7 +22,8 @@ module PactBroker
         # @param [Hash] the parameters to validate
         # @return [Hash] the validation errors to display to the user
         def self.call(params)
-          format_errors(new.call(params&.symbolize_keys).errors)
+          params_to_validate = params.respond_to?(:symbolize_keys) ? params.symbolize_keys : params
+          new.call(params_to_validate)
         end
       end
     end

data/lib/pact_broker/api/contracts/dry_validation_errors_formatter.rb

@@ -5,6 +5,8 @@ module PactBroker
     module Contracts
       module DryValidationErrorsFormatter
 
+        extend self
+
         # Formats the dry validation errors in the expected PactBroker error format of { :key => ["errors"] }
         # where there are no nested hashes.
         # @param [Dry::Validation::MessageSet] errors

data/lib/pact_broker/api/contracts/pagination_query_params_schema.rb

@@ -0,0 +1,19 @@
+require "pact_broker/api/contracts/base_contract"
+
+module PactBroker
+  module Api
+    module Contracts
+      class PaginationQueryParamsSchema < BaseContract
+        params do
+          # legacy format
+          optional(:pageNumber).maybe(:integer).value(gteq?: 1)
+          optional(:pageSize).maybe(:integer).value(gteq?: 1)
+
+          # desired format
+          optional(:page).maybe(:integer).value(gteq?: 1)
+          optional(:size).maybe(:integer).value(gteq?: 1)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts/publish_contracts_contract_contract.rb

@@ -20,23 +20,7 @@ module PactBroker
         rule(:consumerName).validate(:not_blank_if_present)
         rule(:providerName).validate(:not_blank_if_present)
 
-        # validate_consumer_name_in_content
-        rule(:decodedParsedContent, :consumerName, :specification) do
-          consumer_name_in_content = values.dig(:decodedParsedContent, :consumer, :name)
-          if consumer_name_in_content && consumer_name_in_content != values[:consumerName]
-            base.failure(validation_message("consumer_name_in_content_mismatch", { consumer_name_in_content: consumer_name_in_content, consumer_name: values[:consumerName] }))
-          end
-        end
-
-        # validate_provider_name_in_content
-        rule(:decodedParsedContent, :providerName) do
-          provider_name_in_content = values.dig(:decodedParsedContent, :provider, :name)
-          if provider_name_in_content && provider_name_in_content != values[:providerName]
-            base.failure(validation_message("provider_name_in_content_mismatch", { provider_name_in_content: provider_name_in_content, provider_name: values[:providerName] }))
-          end
-        end
-
-        # validate_encoding
+        # validate_encoding (ensure all UTF-8 chars)
         rule(:decodedContent) do
           if value.nil?
             base.failure(validation_message("base64"))
@@ -50,12 +34,39 @@ module PactBroker
           end
         end
 
-        # validate_content_matches_content_type
+        # validate content could be parsed according to its content type
         rule(:decodedParsedContent, :contentType) do
           if values[:decodedParsedContent].nil? && values[:contentType]
             base.failure(validation_message("invalid_content_for_content_type", { content_type: values[:contentType] }))
           end
         end
+
+        # validate parsed contract is a hash
+        rule(:decodedParsedContent, :contentType) do
+          if !base_rule_error? && !values[:decodedParsedContent].is_a?(Hash)
+            base.failure(validation_message("invalid_parsed_contract_class", { actual_class: values[:decodedParsedContent].class }))
+          end
+        end
+
+        # validate consumer name in content matches the details higher in the JSON document
+        rule(:decodedParsedContent, :consumerName, :specification) do
+          if !base_rule_error?
+            consumer_name_in_content = values.dig(:decodedParsedContent, :consumer, :name)
+            if consumer_name_in_content && consumer_name_in_content != values[:consumerName]
+              base.failure(validation_message("consumer_name_in_content_mismatch", { consumer_name_in_content: consumer_name_in_content, consumer_name: values[:consumerName] }))
+            end
+          end
+        end
+
+        # validate provider name in content matches the details higher in the JSON document
+        rule(:decodedParsedContent, :providerName) do
+          if !base_rule_error?
+            provider_name_in_content = values.dig(:decodedParsedContent, :provider, :name)
+            if provider_name_in_content && provider_name_in_content != values[:providerName]
+              base.failure(validation_message("provider_name_in_content_mismatch", { provider_name_in_content: provider_name_in_content, provider_name: values[:providerName] }))
+            end
+          end
+        end
       end
     end
   end

data/lib/pact_broker/api/decorators/base_decorator.rb

@@ -1,9 +1,9 @@
 require "roar/decorator"
 require "roar/json/hal"
 require "pact_broker/api/pact_broker_urls"
-require "pact_broker/api/decorators/decorator_context"
 require "pact_broker/api/decorators/format_date_time"
 require "pact_broker/string_refinements"
+require "pact_broker/hash_refinements"
 
 module PactBroker
   module Api
@@ -14,11 +14,17 @@ module PactBroker
         include PactBroker::Api::PactBrokerUrls
         include FormatDateTime
         using PactBroker::StringRefinements
+        using PactBroker::HashRefinements
 
+        # Call this method to automatically camelize property names without
+        # having to define an :as each time.
         def self.camelize_property_names
           @camelize = true
         end
 
+        # Overrides the default property method to add a camelised :as option
+        # when camelize_property_names has been called for this decorator.
+        # @override
         def self.property(name, options={}, &block)
           if options.delete(:camelize) || @camelize
             camelized_name = name.to_s.camelcase(false).to_sym
@@ -27,6 +33,39 @@ module PactBroker
             super
           end
         end
+
+        # Returns the names of the model associations to eager load for use with this decorator
+        # @return [Array<Symbol>]
+        def self.eager_load_associations
+          if is_collection_resource?
+            collection_item_decorator_class.eager_load_associations
+          else
+            embedded_and_collection_attribute_names
+          end
+        end
+
+        # Returns true if this class is a decorator for a collection
+        # @return [true, false]
+        def self.is_collection_resource?
+          representable_attrs_without_links = representable_attrs.to_h.without("links", "page")
+          representable_attrs_without_links.size == 1 &&
+            representable_attrs_without_links.values.first[:collection] &&
+            representable_attrs_without_links.values.first[:extend]
+        end
+        private_class_method :is_collection_resource?
+
+        # Returns the names of the model attributes that are collections, embedded or nested items
+        # @return [Array<Symbol>]
+        def self.embedded_and_collection_attribute_names
+          representable_attrs.values.select{ | attr| attr[:collection] || attr[:embedded] || attr[:nested] }.collect{ |attr| attr[:name].to_sym }
+        end
+        private_class_method :embedded_and_collection_attribute_names
+
+        # @return [Class] The decorator class used to decorate the items in the collection
+        def self.collection_item_decorator_class
+          representable_attrs.to_h.without("links", "page").values.first[:extend].call
+        end
+        private_class_method :collection_item_decorator_class
       end
     end
   end

data/lib/pact_broker/api/decorators/branch_decorator.rb

@@ -0,0 +1,35 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/timestamps"
+
+module PactBroker
+  module Api
+    module Decorators
+      class BranchDecorator < BaseDecorator
+
+        property :name
+
+        link :self do | user_options |
+          {
+            title: "Branch",
+            href: branch_url(represented, user_options.fetch(:base_url))
+          }
+        end
+
+        link "pb:latest-version" do | user_options |
+          {
+            title: "Latest version for branch",
+            href: latest_version_for_branch_url(represented, user_options.fetch(:base_url))
+          }
+        end
+
+        include Timestamps
+
+        # When this decorator is embedded in the PacticipantBranchesDecorator,
+        # we need to eager load the pacticipants for generating the URL
+        def self.eager_load_associations
+          super + [:pacticipant]
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/branch_version_decorator.rb

@@ -13,6 +13,22 @@ module PactBroker
           }
         end
 
+        link :"pb:branch" do | user_options |
+          {
+            title: "Branch",
+            name: represented.branch.name,
+            href: branch_url(represented.branch, user_options.fetch(:base_url))
+          }
+        end
+
+        link :"pb:version" do | user_options |
+          {
+            title: "Version",
+            name: represented.version.number,
+            href: version_url(user_options.fetch(:base_url), represented.version)
+          }
+        end
+
         include Timestamps
       end
     end

data/lib/pact_broker/api/decorators/configuration.rb

@@ -20,6 +20,25 @@ module PactBroker
           end
         end
 
+        # @param [Class] errors_class will be a Hash class or Dry::Validation::MessageSet class
+        # @param [String] accept_header if this includes application/problem+json we render a application/problem+json response
+        # @return [Class] the decorator class
+        def validation_error_decorator_class_for(errors_class, accept_header)
+          if accept_header&.include?("application/problem+json")
+            if errors_class == Dry::Validation::MessageSet
+              PactBroker::Api::Decorators::DryValidationErrorsProblemJsonDecorator
+            else
+              PactBroker::Api::Decorators::ValidationErrorsProblemJsonDecorator
+            end
+          else
+            if errors_class == Dry::Validation::MessageSet
+              PactBroker::Api::Decorators::DryValidationErrorsDecorator
+            else
+              PactBroker::Api::Decorators::ValidationErrorsDecorator
+            end
+          end
+        end
+
         def self.default_configuration
           Configuration.new
         end

data/lib/pact_broker/api/decorators/custom_error_problem_json_decorator.rb

@@ -3,7 +3,7 @@
 module PactBroker
   module Api
     module Decorators
-      class CustomErrorProblemJSONDecorator
+      class CustomErrorProblemJsonDecorator
 
         # @option title [String]
         # @option type [String]

data/lib/pact_broker/api/decorators/decorator_context_creator.rb

@@ -1,11 +1,56 @@
-require "pact_broker/api/decorators/decorator_context"
+# Builds the Hash that is passed into the Decorator as the `user_options`. It contains the request details, rack env, the (optional) title
+# and anything else that is required by the decorator to render the resource (eg. the pacticipant that the versions belong to)
 
 module PactBroker
   module Api
     module Decorators
       class DecoratorContextCreator
+
+        # @param [PactBroker::BaseResource] the Pact Broker webmachine resource
+        # @param [Hash] options any extra options that need to be passed through to the decorator.
+        # @return [Hash] decorator_context
+
+        # decorator_context [String] :base_url
+        # The location where the Pact Broker is hosted.
+        # eg. http://some.host:9292/pact_broker
+        # Always present
+
+        # decorator_context [String] :resource_url
+        # The resource URL without any query string.
+        # eg. http://some.host:9292/pact_broker/pacticipants/Foo/versions
+        # Always present
+
+        # decorator_context [String] :query_string
+        # The query string.
+        # "page=1&size=50"
+        # May be empty
+
+        # decorator_context [String] :request_url
+        # The full request URL.
+        # eg. http://some.host:9292/pact_broker/pacticipants/Foo/versions?page=1&size=50
+        # Always present
+
+        # decorator_context [Hash] :env
+        # The rack env.
+        # Always present
+
+        # decorator_context [Hash] :resource_title
+        # eg. "Pacticipant versions for Foo"
+        # Optional
+        # Used when a single decorator is being used for multiple resources and the title needs to be
+        # set from the resource.
+
         def self.call(resource, options)
-          Decorators::DecoratorContext.new(resource.base_url, resource.resource_url, resource.request.env, options)
+          env = resource.request.env
+          decorator_context = {}
+          decorator_context[:base_url] = resource.base_url
+          decorator_context[:resource_url] = resource.resource_url
+          decorator_context[:query_string] = query_string = (env["QUERY_STRING"] && !env["QUERY_STRING"].empty? ? env["QUERY_STRING"] : nil)
+          decorator_context[:request_url] = query_string ? resource.resource_url + "?" + query_string : resource.resource_url
+          decorator_context[:env] = env
+          decorator_context[:resource_title] = options[:resource_title]
+          decorator_context.merge!(options)
+          decorator_context
         end
       end
     end

data/lib/pact_broker/api/decorators/deployed_version_decorator.rb

@@ -11,13 +11,14 @@ module PactBroker
         property :currently_deployed, camelize: true
         property :target, camelize: true # deprecated
         property :applicationInstance, getter: lambda { |_| target }
-        include Timestamps
         property :undeployedAt, getter: lambda { |_|  undeployed_at ? FormatDateTime.call(undeployed_at) : nil }, writeable: false
 
         property :pacticipant, :extend => EmbeddedPacticipantDecorator, writeable: false, embedded: true
         property :version, :extend => EmbeddedVersionDecorator, writeable: false, embedded: true
         property :environment, :extend => EnvironmentDecorator, writeable: false, embedded: true
 
+        include Timestamps
+
         link :self do | user_options |
           {
             href: deployed_version_url(represented, user_options.fetch(:base_url))

data/lib/pact_broker/api/decorators/deployed_versions_decorator.rb

@@ -1,11 +1,11 @@
 require "pact_broker/api/decorators/base_decorator"
-require "pact_broker/api/decorators/deployed_version_decorator"
+require "pact_broker/api/decorators/embedded_deployed_version_decorator"
 
 module PactBroker
   module Api
     module Decorators
       class DeployedVersionsDecorator < BaseDecorator
-        collection :entries, as: :deployedVersions, embedded: true, :extend => PactBroker::Api::Decorators::DeployedVersionDecorator
+        collection :entries, as: :deployedVersions, embedded: true, :extend => PactBroker::Api::Decorators::EmbeddedDeployedVersionDecorator
 
         link :self do | context |
           href = append_query_if_present(context[:resource_url], context[:query_string])

data/lib/pact_broker/api/decorators/dry_validation_errors_decorator.rb

@@ -0,0 +1,32 @@
+# Formats Dry::Validation::MessageSet errors into the "old" Pact Broker errors format
+# TODO: delete this in favour of problem+json in the next major version
+
+require "pact_broker/api/contracts/dry_validation_errors_formatter"
+
+module PactBroker
+  module Api
+    module Decorators
+      class DryValidationErrorsDecorator
+
+        # @param errors [Hash]
+        def initialize(errors)
+          @errors = errors
+        end
+
+        # @return [Hash]
+        def to_hash(*_args, **_kwargs)
+          { errors: PactBroker::Api::Contracts::DryValidationErrorsFormatter.format_errors(errors) }
+        end
+
+        # @return [String] JSON
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
+        end
+
+        private
+
+        attr_reader :errors
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/dry_validation_errors_problem_json_decorator.rb

@@ -0,0 +1,24 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/embedded_error_problem_json_decorator"
+# Formats a Dry::Validation::MessageSet into application/problem+json format.
+# according to the spec at https://www.rfc-editor.org/rfc/rfc9457.html
+
+# Decorates Dry::Validation::MessageSet
+# Defaults to displaying validation errors, but the top level
+# details may be overridden to display error responses for other HTTP statuses (eg. 409)
+module PactBroker
+  module Api
+    module Decorators
+      class DryValidationErrorsProblemJsonDecorator < BaseDecorator
+
+        property :title,    getter: -> (user_options:, **) { user_options[:title]    || "Validation errors" }
+        property :type,     getter: -> (user_options:, **) { user_options[:type]     || "#{user_options[:base_url]}/problems/validation-error" }
+        property :detail,   getter: -> (user_options:, **) { user_options[:detail]   || nil }
+        property :status,   getter: -> (user_options:, **) { user_options[:status]   || 400 }
+        property :instance, getter: -> (user_options:, **) { user_options[:instance] || "/" }
+
+        collection :entries, as: :errors, extend: PactBroker::Api::Decorators::EmbeddedErrorProblemJsonDecorator
+      end
+    end
+  end
+end

data/lib/pact_broker/api/decorators/embedded_branch_version_decorator.rb

@@ -5,12 +5,12 @@ module PactBroker
   module Api
     module Decorators
       class EmbeddedBranchVersionDecorator < BaseDecorator
-        property :branch_name, as: :name
+        property :branch_name, as: :name # TODO rename this to branchName in next major version
         property :latest?, as: :latest
 
         link :self do | options |
           {
-            title: "Version branch",
+            title: "Branch version",
             name: represented.branch_name,
             href: branch_version_url(represented, options[:base_url])
           }