fixup! solidify interfaces to match OF API & client

open-feature · May 1, 2024 · a6c2c55 · a6c2c55
1 parent 8a6ae70
commit a6c2c55
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -377,7 +377,7 @@ While you may use global methods to interact with the API, it is recommended to
 openfeature.SetProvider(myProvider)
 
 // singleton instance - preferred
-apiInstance := openfeature.GetAPIInstance()
+apiInstance := openfeature.GetApiInstance()
 apiInstance.SetProvider(myProvider)
 ```
 
@@ -388,7 +388,7 @@ Similarly, while you have options (due to historical reasons) to create a client
 openfeature.NewClient("myClient")
 
 // using API instance - preferred
-apiInstance := openfeature.GetAPIInstance()
+apiInstance := openfeature.GetApiInstance()
 apiInstance.GetClient()
 apiInstance.GetNamedClient("myClient")
 ```

diff --git a/openfeature/openfeature.go b/openfeature/openfeature.go
@@ -24,8 +24,8 @@ func initSingleton() {
 	api = NewEvaluationAPI(exec, logger)
 }
 
-// GetAPIInstance returns the current singleton IOFApi instance
-func GetAPIInstance() IOFApi {
+// GetApiInstance returns the current singleton IOFApi instance
+func GetApiInstance() IOFApi {
 	return api
 }
 

diff --git a/openfeature/openfeature_test.go b/openfeature/openfeature_test.go
@@ -20,7 +20,7 @@ func TestRequirement_1_1_1(t *testing.T) {
 	mockProvider := NewMockFeatureProvider(ctrl)
 	mockProvider.EXPECT().Metadata().AnyTimes()
 
-	ofAPI := GetAPIInstance()
+	ofAPI := GetApiInstance()
 
 	// set through instance level
 	err := ofAPI.SetProvider(mockProvider)