Remove format configuration option and update related documentation

Author: GrantBirki

docs/configuration.md

@@ -105,17 +105,9 @@ When set to `true`, normalizes incoming HTTP headers by lowercasing and trimming
 
 **Default:** `true`
 
-### `format`
-
-Sets the request/response format for the webhook server. This determines how incoming requests are parsed and how responses are formatted.
-
-**Default:** `json`  
-**Valid values:** `json`, `txt`, `xml`, `any`  
-**Example:** `json`
-
 ### `default_format`
 
-Sets the default response format when no specific format is requested. This works in conjunction with the `format` setting to determine response formatting.
+Sets the default response format when no specific format is requested.
 
 **Default:** `json`  
 **Valid values:** `json`, `txt`, `xml`, `any`  

docs/handler_plugins.md

@@ -73,7 +73,7 @@ Example response format:
 }
 ```
 
-> **Note**: The JSON format behavior can be configured using the `format` and `default_format` options in your global configuration. See the [Configuration documentation](./configuration.md) for more details.
+> **Note**: The JSON format behavior can be configured using the `default_format` option in your global configuration. See the [Configuration documentation](./configuration.md) for more details.
 
 ### `payload` Parameter
 

lib/hooks/app/api.rb

@@ -39,7 +39,6 @@ def self.create(config:, endpoints:, log:)
           content_type :xml, "application/xml"
           content_type :any, "*/*"
 
-          format config[:format] || :json
           default_format config[:default_format] || :json
         end
 

lib/hooks/app/endpoints/catchall.rb

@@ -22,7 +22,6 @@ class CatchallEndpoint < Grape::API
       content_type :txt, "text/plain"
       content_type :xml, "application/xml"
       content_type :any, "*/*"
-      format :json
       default_format :json
 
       def self.mount_path(config)

lib/hooks/app/endpoints/health.rb

@@ -11,7 +11,6 @@ class HealthEndpoint < Grape::API
       content_type :txt, "text/plain"
       content_type :xml, "application/xml"
       content_type :any, "*/*"
-      format :json
       default_format :json
 
       get do

lib/hooks/app/endpoints/version.rb

@@ -11,7 +11,6 @@ class VersionEndpoint < Grape::API
       content_type :txt, "text/plain"
       content_type :xml, "application/xml"
       content_type :any, "*/*"
-      format :json
       default_format :json
 
       get do

lib/hooks/core/config_loader.rb

@@ -21,7 +21,6 @@ class ConfigLoader
         endpoints_dir: "./config/endpoints",
         use_catchall_route: false,
         normalize_headers: true,
-        format: :json,
         default_format: :json
       }.freeze
 
@@ -143,7 +142,6 @@ def self.load_env_config
           "HOOKS_ENDPOINTS_DIR" => :endpoints_dir,
           "HOOKS_USE_CATCHALL_ROUTE" => :use_catchall_route,
           "HOOKS_NORMALIZE_HEADERS" => :normalize_headers,
-          "HOOKS_FORMAT" => :format,
           "HOOKS_DEFAULT_FORMAT" => :default_format,
           "HOOKS_SOME_STRING_VAR" => :some_string_var # Added for test
         }
@@ -159,7 +157,7 @@ def self.load_env_config
           when :use_catchall_route, :normalize_headers
             # Convert string to boolean
             env_config[config_key] = %w[true 1 yes on].include?(value.downcase)
-          when :format, :default_format
+          when :default_format
             # Convert string to symbol
             env_config[config_key] = value.to_sym
           else

lib/hooks/core/config_validator.rb

@@ -27,6 +27,7 @@ class ValidationError < StandardError; end
         optional(:endpoints_dir).filled(:string)
         optional(:use_catchall_route).filled(:bool)
         optional(:normalize_headers).filled(:bool)
+        optional(:default_format).filled(:symbol, included_in?: %i[json txt xml any])
 
         optional(:ip_filtering).hash do
           optional(:ip_header).filled(:string)

spec/acceptance/acceptance_tests.rb

@@ -532,13 +532,10 @@ def expired_unix_timestamp(seconds_ago = 600)
         response = make_request(:post, "/webhooks/boomtown_with_error", payload, json_headers)
         expect_response(response, Net::HTTPInternalServerError)
 
-        # With JSON default format, even string errors are JSON-encoded
-        expect(response.content_type).to eq("application/json")
+        expect(response.content_type).to eq("text/plain")
         expect(response.code).to eq("500")
 
-        # The error body should be the JSON-encoded string
-        body = parse_json_response(response)
-        expect(body).to eq("boomtown_with_error: the payload triggered a simple text boomtown error")
+        expect(response.body).to match(/boomtown_with_error: the payload triggered a simple text boomtown error/)
       end
     end
 

spec/unit/lib/hooks/core/config_loader_spec.rb

@@ -20,7 +20,6 @@
           endpoints_dir: "./config/endpoints",
           use_catchall_route: false,
           normalize_headers: true,
-          format: :json,
           default_format: :json
         )
       end
@@ -201,12 +200,10 @@
       end
 
       it "converts format environment variables to symbols" do
-        ENV["HOOKS_FORMAT"] = "txt"
         ENV["HOOKS_DEFAULT_FORMAT"] = "xml"
 
         config = described_class.load
 
-        expect(config[:format]).to eq(:txt)
         expect(config[:default_format]).to eq(:xml)
       end
     end