nits

skip-mev · Apr 9, 2024 · ab33631 · ab33631
1 parent 948ea6b
commit ab33631
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/oracle/config/api.go b/oracle/config/api.go
@@ -51,8 +51,8 @@ type Endpoint struct {
 	// URL is the URL that is used to fetch data from the API.
 	URL string `json:"url"`
 
-	// Authentication  is used to meta-data related to authentication for the API's
-	// endpoint.
+	// Authentication holds all data necessary for an API provider to authenticate with
+	// an endpoint.
 	Authentication Authentication `json:"authentication"`
 }
 

diff --git a/oracle/config/api_test.go b/oracle/config/api_test.go
@@ -167,7 +167,7 @@ func TestAPIConfig(t *testing.T) {
 			expectedErr: true,
 		},
 		{
-			name: "bad config with invalid endpoint",
+			name: "bad config with invalid endpoint authentication (API key missing)",
 			config: config.APIConfig{
 				Enabled:          true,
 				Timeout:          time.Second,
@@ -188,7 +188,7 @@ func TestAPIConfig(t *testing.T) {
 			expectedErr: true,
 		},
 		{
-			name: "bad config with invalid endpoint (HTTP header field missing)",
+			name: "bad config with invalid endpoint authentication (HTTP header field missing)",
 			config: config.APIConfig{
 				Enabled:          true,
 				Timeout:          time.Second,