chore: reformatted Markdown for consistency

opensearch-project · Jun 22, 2022 · 9c447b2 · 9c447b2
1 parent 1af5ede
commit 9c447b2
Showing 1 changed file with 150 additions and 148 deletions.
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
@@ -1,90 +1,92 @@
 - [User Guide](#user-guide)
-  - [Example](#example)
-  - [How to use IAMs as authentication method](#how-to-use-iams-as-authentication-method)
+    - [Example](#example)
+    - [How to use IAMs as authentication method](#how-to-use-iams-as-authentication-method)
+
 # User Guide
 
 ## Example
+
 In the example below, we create a client, an index with non-default settings, insert a document to the index,
 search for the document, delete the document and finally delete the index.
 
 ```go
 package main
 
 import (
-    "os"
-    "context"
-    "crypto/tls"
-    "fmt"
-    opensearch "github.com/opensearch-project/opensearch-go/v2"
-    opensearchapi "github.com/opensearch-project/opensearch-go/v2/opensearchapi"
-    "net/http"
-    "strings"
+	"os"
+	"context"
+	"crypto/tls"
+	"fmt"
+	opensearch "github.com/opensearch-project/opensearch-go/v2"
+	opensearchapi "github.com/opensearch-project/opensearch-go/v2/opensearchapi"
+	"net/http"
+	"strings"
 )
 
 const IndexName = "go-test-index1"
 
 func main() {
 
-    // Initialize the client with SSL/TLS enabled.
-    client, err := opensearch.NewClient(opensearch.Config{
-        Transport: &http.Transport{
-            TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, // For testing only. Use certificate for validation.
-        },
-        Addresses: []string{"https://localhost:9200"},
-        Username:  "admin", // For testing only. Don't store credentials in code.
-        Password:  "admin",
-    })
-    if err != nil {
-        fmt.Println("cannot initialize", err)
-        os.Exit(1)
-    }
-    
-    // Print OpenSearch version information on console.
-    fmt.Println(client.Info())
-    
-    // Define index mapping.
-    mapping := strings.NewReader(`{
+	// Initialize the client with SSL/TLS enabled.
+	client, err := opensearch.NewClient(opensearch.Config{
+		Transport: &http.Transport{
+			TLSClientConfig: &tls.Config{InsecureSkipVerify: true}, // For testing only. Use certificate for validation.
+		},
+		Addresses: []string{"https://localhost:9200"},
+		Username:  "admin", // For testing only. Don't store credentials in code.
+		Password:  "admin",
+	})
+	if err != nil {
+		fmt.Println("cannot initialize", err)
+		os.Exit(1)
+	}
+
+	// Print OpenSearch version information on console.
+	fmt.Println(client.Info())
+
+	// Define index mapping.
+	mapping := strings.NewReader(`{
      'settings': {
        'index': {
             'number_of_shards': 4
             }
           }
      }`)
-    
-    // Create an index with non-default settings. 
-    createIndex := opensearchapi.IndicesCreateRequest{
-        Index: IndexName, 
-        Body:  mapping,
-    }
-    createIndexResponse, err := createIndex.Do(context.Background(), client)
-    if err != nil {
-        fmt.Println("failed to create index ", err)
-        os.Exit(1)
-    }
-    fmt.Println(createIndexResponse)
-    
-    // Add a document to the index.
-    document := strings.NewReader(`{
+
+	// Create an index with non-default settings.
+	createIndex := opensearchapi.IndicesCreateRequest{
+		Index: IndexName,
+		Body:  mapping,
+	}
+	createIndexResponse, err := createIndex.Do(context.Background(), client)
+	if err != nil {
+		fmt.Println("failed to create index ", err)
+		os.Exit(1)
+	}
+	fmt.Println(createIndexResponse)
+
+	// Add a document to the index.
+	document := strings.NewReader(`{
         "title": "Moneyball",
         "director": "Bennett Miller",
         "year": "2011"
     }`)
-    
-    docId := "1"
-    req := opensearchapi.IndexRequest{
-        Index:      IndexName,
-        DocumentID: docId,
-        Body:       document,
-    }
-    insertResponse, err := req.Do(context.Background(), client)
-    if err != nil {
-        fmt.Println("failed to insert document ", err)
-        os.Exit(1)
-    }
-    fmt.Println(insertResponse)
-    
-    // Search for the document.
-    content := strings.NewReader(`{
+
+	docId := "1"
+	req := opensearchapi.IndexRequest{
+		Index:      IndexName,
+		DocumentID: docId,
+		Body:       document,
+	}
+	insertResponse, err := req.Do(context.Background(), client)
+	if err != nil {
+		fmt.Println("failed to insert document ", err)
+		os.Exit(1)
+	}
+	fmt.Println(insertResponse)
+
+	// Search for the document.
+	content := strings.NewReader(`{
        "size": 5,
        "query": {
            "multi_match": {
@@ -93,43 +95,43 @@ func main() {
            }
       }
     }`)
-    
-    search := opensearchapi.SearchRequest{
-        Body: content,
-    }
-    
-    searchResponse, err := search.Do(context.Background(), client)
-    if err != nil {
-        fmt.Println("failed to search document ", err)
-        os.Exit(1)
-    }
-    fmt.Println(searchResponse)
-    
-    // Delete the document.
-    delete := opensearchapi.DeleteRequest{
-        Index:      IndexName,
-        DocumentID: docId,
-    }
-    
-    deleteResponse, err := delete.Do(context.Background(), client)
-    if err != nil {
-        fmt.Println("failed to delete document ", err)
-        os.Exit(1)
-    }
-    fmt.Println("deleting document")
-    fmt.Println(deleteResponse)
-    
-    // Delete previously created index.
-    deleteIndex := opensearchapi.IndicesDeleteRequest{
-        Index: []string{IndexName},
-    }
-    
-    deleteIndexResponse, err := deleteIndex.Do(context.Background(), client)
-    if err != nil {
-        fmt.Println("failed to delete index ", err)
-        os.Exit(1)
-    }
-    fmt.Println("deleting index", deleteIndexResponse)
+
+	search := opensearchapi.SearchRequest{
+		Body: content,
+	}
+
+	searchResponse, err := search.Do(context.Background(), client)
+	if err != nil {
+		fmt.Println("failed to search document ", err)
+		os.Exit(1)
+	}
+	fmt.Println(searchResponse)
+
+	// Delete the document.
+	delete := opensearchapi.DeleteRequest{
+		Index:      IndexName,
+		DocumentID: docId,
+	}
+
+	deleteResponse, err := delete.Do(context.Background(), client)
+	if err != nil {
+		fmt.Println("failed to delete document ", err)
+		os.Exit(1)
+	}
+	fmt.Println("deleting document")
+	fmt.Println(deleteResponse)
+
+	// Delete previously created index.
+	deleteIndex := opensearchapi.IndicesDeleteRequest{
+		Index: []string{IndexName},
+	}
+
+	deleteIndexResponse, err := deleteIndex.Do(context.Background(), client)
+	if err != nil {
+		fmt.Println("failed to delete index ", err)
+		os.Exit(1)
+	}
+	fmt.Println("deleting index", deleteIndexResponse)
 }
 
 ```
@@ -223,61 +225,61 @@ func main() {
 package main
 
 import (
-  "context"
-  "io"
-  "log"
-
-  "github.com/aws/aws-sdk-go-v2/config"
-  "github.com/opensearch-project/opensearch-go/v2"
-  "github.com/opensearch-project/opensearch-go/v2/opensearchapi"
-  requestsigner "github.com/opensearch-project/opensearch-go/v2/signer/awsv2"
+	"context"
+	"io"
+	"log"
+
+	"github.com/aws/aws-sdk-go-v2/config"
+	"github.com/opensearch-project/opensearch-go/v2/opensearchapi"
+	requestsigner "github.com/opensearch-project/opensearch-go/v2/signer/awsv2"
 )
 
 const endpoint = "" // e.g. https://opensearch-domain.region.com
 
 func main() {
-  ctx := context.Background()
-
-  cfg, err := config.LoadDefaultConfig(ctx)
-  if err != nil {
-    log.Fatal(err) // Do not log.fatal in a production ready app.
-  }
-
-  // Create an AWS request Signer and load AWS configuration using default config folder or env vars.
-  // See https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html#request-signing-go
-  signer, err := requestsigner.NewSigner(cfg)
-  if err != nil {
-    log.Fatal(err) // Do not log.fatal in a production ready app.
-  }
-
-  // Create an opensearch client and use the request-signer
-  client, err := opensearch.NewClient(opensearch.Config{
-    Addresses: []string{endpoint},
-    Signer:    signer,
-  })
-  if err != nil {
-    log.Fatal("client creation err", err)
-  }
-
-  ping := opensearchapi.PingRequest{}
-
-  resp, err := ping.Do(ctx, client)
-  if err != nil {
-    log.Fatal(err)
-  }
-  defer resp.Body.Close()
-
-  if resp.IsError() {
-    log.Println("ping response status ", resp.Status())
-
-    respBody, err := io.ReadAll(resp.Body)
-    if err != nil {
-      log.Fatal("response body read err", err)
-    }
-
-    log.Fatal("ping resp body", respBody)
-  }
-
-  log.Println("PING OK")
+	ctx := context.Background()
+
+	cfg, err := config.LoadDefaultConfig(ctx)
+	if err != nil {
+		log.Fatal(err) // Do not log.fatal in a production ready app.
+	}
+
+	// Create an AWS request Signer and load AWS configuration using default config folder or env vars.
+	// See https://docs.aws.amazon.com/opensearch-service/latest/developerguide/request-signing.html#request-signing-go
+	signer, err := requestsigner.NewSigner(cfg)
+	if err != nil {
+		log.Fatal(err) // Do not log.fatal in a production ready app.
+	}
+
+	// Create an opensearch client and use the request-signer
+	client, err := opensearch.NewClient(opensearch.Config{
+		Addresses: []string{endpoint},
+		Signer:    signer,
+	})
+	if err != nil {
+		log.Fatal("client creation err", err)
+	}
+
+	ping := opensearchapi.PingRequest{}
+
+	resp, err := ping.Do(ctx, client)
+	if err != nil {
+		log.Fatal(err)
+	}
+	defer resp.Body.Close()
+
+	if resp.IsError() {
+		log.Println("ping response status ", resp.Status())
+
+		respBody, err := io.ReadAll(resp.Body)
+		if err != nil {
+			log.Fatal("response body read err", err)
+		}
+
+		log.Fatal("ping resp body", respBody)
+	}
+
+	log.Println("PING OK")
 }
+
 ```