Merge pull request #464 from marcusvnac/improve_provider_base_url_doc

Improving Provider VerifyRequest - ProviderBaseURL documentation.
pact-foundation · Jan 21, 2025 · 61f9e2a · 61f9e2a
2 parents e9d1115 + 7766ec2
commit 61f9e2a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/provider/verify_request.go b/provider/verify_request.go
@@ -25,6 +25,9 @@ type Hook func() error
 // VerifyRequest contains the verification params.
 type VerifyRequest struct {
 	// Default URL to hit during provider verification.
+	//
+	// If your URL has a base path, make sure the URL includes the schema.
+	// Otherwise, the [net/url] package will consider it as opaque, and the base path will be lost when the URL is parsed.
 	ProviderBaseURL string
 
 	// Specify one or more additional transports to communicate to the given provider