Add WithCaptureHTTPRequest (#387)

* add WithCaptureHTTPRequest, prep for template change

Author: DiogoFerrao

core/CHANGELOG.md

@@ -1,3 +1,6 @@
+## v0.11.0 (2024-04-09)
+- **Feature:** Add method `WithCaptureHTTPRequest` to package `runtime`, which allows capture of HTTP requests for debugging purposes.
+
 ## v0.10.1 (2024-03-20)
 - **Improvement:** Update `ConfigureRegion` method to take into account global servers without a region variable
 

core/config/config.go

@@ -52,6 +52,9 @@ var (
 
 	// ContextHTTPResponse holds the raw HTTP response after the request has completed.
 	ContextHTTPResponse = contextKey("httpResponse")
+
+	// ContextHTTPRequest holds the raw HTTP request.
+	ContextHTTPRequest = contextKey("httpRequest")
 )
 
 // BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

core/runtime/runtime.go

@@ -12,3 +12,9 @@ import (
 func WithCaptureHTTPResponse(parent context.Context, resp **http.Response) context.Context {
 	return context.WithValue(parent, config.ContextHTTPResponse, resp)
 }
+
+// WithCaptureHTTPRequest adds the raw HTTP request retrieval annotation to the parent context.
+// After the request has completed, the req parameter will contain the raw HTTP request made to the API.
+func WithCaptureHTTPRequest(parent context.Context, req **http.Request) context.Context {
+	return context.WithValue(parent, config.ContextHTTPRequest, req)
+}