feat: add dochub link to SDK code sample (#775)

Author: andreaangiolillo

tools/cli/internal/openapi/filter/code_sample.go

@@ -16,6 +16,7 @@ package filter
 
 import (
 	"bytes"
+	_ "embed"
 	"fmt"
 	goFormat "go/format"
 	"strings"
@@ -28,33 +29,8 @@ import (
 	"golang.org/x/text/language"
 )
 
-const goSDKTemplate = `import (
-  "os"
-  "context"
-  "log"
-  sdk "go.mongodb.org/atlas-sdk/v{{ .Version }}/admin"
-)
-
-func main() {
-  ctx := context.Background()
-  clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
-  clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
-
-  client, err := sdk.NewClient(
-    sdk.UseOAuthAuth(clientID, clientSecret),
-    sdk.UseBaseURL(url))
-
-  if err != nil {
-	log.Fatalf("Error: %v", err)
-  }
-  
-  params = &sdk.{{ .OperationID }}ApiParams{}
-{{ if eq .Method "DELETE" }}  httpResp, err := client.{{ .Tag }}Api.
-    {{ .OperationID }}WithParams(ctx, params).
-    Execute(){{ else }}  sdkResp, httpResp, err := client.{{ .Tag }}Api.
-    {{ .OperationID }}WithParams(ctx, params).
-    Execute(){{ end}}
-}`
+//go:embed go_sdk_code_sample.go.tmpl
+var goSDKTemplate string
 
 const codeSampleExtensionName = "x-codeSamples"
 

tools/cli/internal/openapi/filter/code_sample_test.go

@@ -93,14 +93,15 @@ func TestCodeSampleFilter(t *testing.T) {
 										"\tctx := context.Background()\n" +
 										"\tclientID := os.Getenv(\"MONGODB_ATLAS_CLIENT_ID\")\n" +
 										"\tclientSecret := os.Getenv(\"MONGODB_ATLAS_CLIENT_SECRET\")\n\n" +
+										"\t// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth\n" +
 										"\tclient, err := sdk.NewClient(\n" +
 										"\t\tsdk.UseOAuthAuth(clientID, clientSecret),\n" +
 										"\t\tsdk.UseBaseURL(url))\n\n" +
 										"\tif err != nil {\n" + "\t\tlog.Fatalf(\"Error: %v\", err)\n\t}\n\n" +
 										"\tparams = &sdk.TestOperationIDApiParams{}\n" +
 										"\tsdkResp, httpResp, err := client.TestTagApi.\n" +
 										"\t\tTestOperationIDWithParams(ctx, params).\n" +
-										"\t\tExecute()" + "\n}",
+										"\t\tExecute()" + "\n}\n",
 								},
 								{
 									Lang:  "cURL",

tools/cli/internal/openapi/filter/go_sdk_code_sample.go.tmpl

@@ -0,0 +1,28 @@
+import (
+  "os"
+  "context"
+  "log"
+  sdk "go.mongodb.org/atlas-sdk/v{{ .Version }}/admin"
+)
+
+func main() {
+  ctx := context.Background()
+  clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
+  clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
+
+  // See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
+  client, err := sdk.NewClient(
+    sdk.UseOAuthAuth(clientID, clientSecret),
+    sdk.UseBaseURL(url))
+
+  if err != nil {
+	log.Fatalf("Error: %v", err)
+  }
+
+  params = &sdk.{{ .OperationID }}ApiParams{}
+{{ if eq .Method "DELETE" }}  httpResp, err := client.{{ .Tag }}Api.
+    {{ .OperationID }}WithParams(ctx, params).
+    Execute(){{ else }}  sdkResp, httpResp, err := client.{{ .Tag }}Api.
+    {{ .OperationID }}WithParams(ctx, params).
+    Execute(){{ end}}
+}