From 5ebc1bfabd578ee6d7ce0187fafc14dd31480daf Mon Sep 17 00:00:00 2001
From: mmaruniak <mmaruniak@cimpress.com>
Date: Wed, 10 Apr 2024 12:57:52 +0200
Subject: [PATCH] Update httpClient.ts

Add more description
---
 src/httpClient/httpClient.ts | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/httpClient/httpClient.ts b/src/httpClient/httpClient.ts
index 26b0112..dbf0538 100644
--- a/src/httpClient/httpClient.ts
+++ b/src/httpClient/httpClient.ts
@@ -366,7 +366,8 @@ export interface HttpClientOptions {
    */
   timeout?: number;
   /**
-   * Override the default mapping of status code when wrapping error responses returned by dependencies into ClientException
+   * Override the default mapping of status code when wrapping error responses returned by dependencies into ClientException.
+   * This is useful, when dependent services return incorrect status codes than then drive incorrect behavior upstream (e.g. 403 instead of 503)
    */
   clientExceptionStatusCodeMapOverride?: Record<number, number>;
 }