From ce7dc703033cbb0a7fad4500cbbf3c69242ab3e7 Mon Sep 17 00:00:00 2001 From: Beth Skurrie Date: Wed, 22 Nov 2023 11:31:05 +1100 Subject: [PATCH] docs: update comments --- lib/pact_broker/api/resources/error_response_generator.rb | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/pact_broker/api/resources/error_response_generator.rb b/lib/pact_broker/api/resources/error_response_generator.rb index 3a6e104cf..c4f757b40 100644 --- a/lib/pact_broker/api/resources/error_response_generator.rb +++ b/lib/pact_broker/api/resources/error_response_generator.rb @@ -3,8 +3,9 @@ require "pact_broker/errors" require "pact_broker/messages" -# Generates the response headers and body for use when there is an unexpected -# error when executing a Webmachine resource request. +# Generates the response headers and body for use when there is a runtime +# error in the business logic (services and repositories) when executing a Webmachine resource request. +# Obfuscates any exception messages that might expose vulnerablities in production. # Uses the Accept header to determine whether to return application/problem+json # or application/hal+json, for backwards compatibility. # In the next major version of the Pact Broker, all error responses