Explain the PingEndpoint const

munriver98 · Jun 26, 2019 · ef77ca4 · ef77ca4
1 parent 7289ee1
commit ef77ca4
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/tfe.go b/tfe.go
@@ -32,7 +32,8 @@ const (
 	DefaultAddress = "https://app.terraform.io"
 	// DefaultBasePath on which the API is served.
 	DefaultBasePath = "/api/v2/"
-	PingEndpoint    = "ping"
+	// No-op API endpoint used to configure the rate limiter
+	PingEndpoint = "ping"
 )
 
 var (