docs(generated): add imports and service initializing into examples

Generated SDK source code using: - Generator version 3.98.0 - Specification version 1.0.0-dev0.1.22 - Automation (cloudant-sdks) version 4743b62
IBM · Dec 13, 2024 · 4b36732 · 4b36732
1 parent 2dffbe6
commit 4b36732
Show file tree

Hide file tree

Showing 85 changed files with 2,424 additions and 51 deletions.
diff --git a/examples/README.md b/examples/README.md
diff --git a/examples/snippets/deleteAttachment/example_request.go b/examples/snippets/deleteAttachment/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteAttachmentOptions := service.NewDeleteAttachmentOptions(
   "products",
   "1000042",

diff --git a/examples/snippets/deleteDatabase/example_request.go b/examples/snippets/deleteDatabase/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteDatabaseOptions := service.NewDeleteDatabaseOptions(
   "<db-name>",
 )

diff --git a/examples/snippets/deleteDesignDocument/example_request.go b/examples/snippets/deleteDesignDocument/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteDesignDocumentOptions := service.NewDeleteDesignDocumentOptions(
   "products",
   "appliances",

diff --git a/examples/snippets/deleteDocument/example_request.go b/examples/snippets/deleteDocument/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteDocumentOptions := service.NewDeleteDocumentOptions(
   "orders",
   "order00058",

diff --git a/examples/snippets/deleteIndex/example_request.go b/examples/snippets/deleteIndex/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteIndexOptions := service.NewDeleteIndexOptions(
   "users",
   "json-index",

diff --git a/examples/snippets/deleteLocalDocument/example_request.go b/examples/snippets/deleteLocalDocument/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteLocalDocumentOptions := service.NewDeleteLocalDocumentOptions(
   "orders",
   "local-0007741142412418284",

diff --git a/examples/snippets/deleteReplicationDocument/example_request.go b/examples/snippets/deleteReplicationDocument/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 deleteReplicationDocumentOptions := service.NewDeleteReplicationDocumentOptions(
   "repldoc-example",
 )

diff --git a/examples/snippets/getActiveTasks/example_request.go b/examples/snippets/getActiveTasks/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getActiveTasksOptions := service.NewGetActiveTasksOptions()
 
 activeTask, response, err := service.GetActiveTasks(getActiveTasksOptions)

diff --git a/examples/snippets/getActivityTrackerEvents/example_request.go b/examples/snippets/getActivityTrackerEvents/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getActivityTrackerEventsOptions := service.NewGetActivityTrackerEventsOptions()
 
 activityTrackerEvents, response, err := service.GetActivityTrackerEvents(getActivityTrackerEventsOptions)

diff --git a/examples/snippets/getAllDbs/example_request.go b/examples/snippets/getAllDbs/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getAllDbsOptions := service.NewGetAllDbsOptions()
 
 result, response, err := service.GetAllDbs(getAllDbsOptions)

diff --git a/examples/snippets/getAttachment/example_request.go b/examples/snippets/getAttachment/example_request.go
@@ -1,4 +1,19 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+  "io"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getAttachmentOptions := service.NewGetAttachmentOptions(
   "products",
   "1000042",
@@ -10,7 +25,7 @@ if err != nil {
   panic(err)
 }
 
-data, _ := ioutil.ReadAll(result)
+data, _ := io.ReadAll(result)
 fmt.Println("\n", string(data))
 // section: markdown
 // This example requires the `product_details.txt` attachment in `1000042` document to exist. To create the attachment, see [Create or modify an attachment.](#putattachment)
diff --git a/examples/snippets/getCapacityThroughputInformation/example_request.go b/examples/snippets/getCapacityThroughputInformation/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getCapacityThroughputInformationOptions := service.NewGetCapacityThroughputInformationOptions()
 
 capacityThroughputInformation, response, err := service.GetCapacityThroughputInformation(getCapacityThroughputInformationOptions)

diff --git a/examples/snippets/getCorsInformation/example_request.go b/examples/snippets/getCorsInformation/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getCorsInformationOptions := service.NewGetCorsInformationOptions()
 
 corsConfiguration, response, err := service.GetCorsInformation(getCorsInformationOptions)

diff --git a/examples/snippets/getCurrentThroughputInformation/example_request.go b/examples/snippets/getCurrentThroughputInformation/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getCurrentThroughputInformationOptions := service.NewGetCurrentThroughputInformationOptions()
 
 currentThroughputInformation, response, err := service.GetCurrentThroughputInformation(getCurrentThroughputInformationOptions)

diff --git a/examples/snippets/getDatabaseInformation/example_request.go b/examples/snippets/getDatabaseInformation/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getDatabaseInformationOptions := service.NewGetDatabaseInformationOptions(
   "products",
 )

diff --git a/examples/snippets/getDbUpdates/example_request.go b/examples/snippets/getDbUpdates/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getDbUpdatesOptions := service.NewGetDbUpdatesOptions()
 getDbUpdatesOptions.SetFeed("normal")
 getDbUpdatesOptions.SetHeartbeat(10000)

diff --git a/examples/snippets/getDesignDocument/example_request.go b/examples/snippets/getDesignDocument/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getDesignDocumentOptions := service.NewGetDesignDocumentOptions(
   "products",
   "appliances",

diff --git a/examples/snippets/getDesignDocumentInformation/example_request.go b/examples/snippets/getDesignDocumentInformation/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getDesignDocumentInformationOptions := service.NewGetDesignDocumentInformationOptions(
   "products",
   "appliances",

diff --git a/examples/snippets/getDocument/example_request.go b/examples/snippets/getDocument/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getDocumentOptions := service.NewGetDocumentOptions(
   "products",
   "1000042",

diff --git a/examples/snippets/getDocumentShardsInfo/example_request.go b/examples/snippets/getDocumentShardsInfo/example_request.go
@@ -1,4 +1,18 @@
+// section: code imports
+import (
+  "encoding/json"
+  "fmt"
+
+  "github.com/IBM/cloudant-go-sdk/cloudantv1"
+)
 // section: code
+service, err := cloudantv1.NewCloudantV1(
+  &cloudantv1.CloudantV1Options{},
+)
+if err != nil {
+  panic(err)
+}
+
 getDocumentShardsInfoOptions := service.NewGetDocumentShardsInfoOptions(
   "products",
   "1000042",