Preparing for release, 4.0.0 (#530)

* internal/version: bump version to 4.0.0 Signed-off-by: Jakob Hahn <[email protected]> * changelog: add 4.0.0 release Signed-off-by: Jakob Hahn <[email protected]> * change reverence of opensearch-go/v3 to opensearch-go/v4 Signed-off-by: Jakob Hahn <[email protected]> --------- Signed-off-by: Jakob Hahn <[email protected]>
opensearch-project · Apr 16, 2024 · ea3e57a · ea3e57a
1 parent d98790b
commit ea3e57a
Show file tree

Hide file tree

Showing 297 changed files with 454 additions and 454 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
-## [Unreleased]
+## [4.0.0]
 
 ### Added
 - Adds GlobalIOUsage struct for nodes stats ([#506](https://github.com/opensearch-project/opensearch-go/pull/506))
@@ -14,7 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Adds security plugin ([#507](https://github.com/opensearch-project/opensearch-go/pull/507))
 - Adds security settings to container for security testing ([#507](https://github.com/opensearch-project/opensearch-go/pull/507))
 - Adds cluster.get-certs to copy admin certs out of the container ([#507](https://github.com/opensearch-project/opensearch-go/pull/507))
-- Adds the `Fields` field containing stored fields to the `DocumentGetResp` struct (#526)[https://github.com/opensearch-project/opensearch-go/pull/526]
+- Adds the `Fields` field containing stored fields to the `DocumentGetResp` struct ([#526](https://github.com/opensearch-project/opensearch-go/pull/526))
 - Adds ism plugin ([#524](https://github.com/opensearch-project/opensearch-go/pull/524))
 
 ### Changed
@@ -193,7 +193,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Bumps `github.com/stretchr/testify` from 1.8.0 to 1.8.1
 - Bumps `github.com/aws/aws-sdk-go` from 1.44.45 to 1.44.132
 
-[Unreleased]: https://github.com/opensearch-project/opensearch-go/compare/v3.1.0...HEAD
+[4.0.0]: https://github.com/opensearch-project/opensearch-go/compare/v3.1.0...v4.0.0
 [3.1.0]: https://github.com/opensearch-project/opensearch-go/compare/v3.0.0...v3.1.0
 [3.0.0]: https://github.com/opensearch-project/opensearch-go/compare/v2.3.0...v3.0.0
 [2.3.0]: https://github.com/opensearch-project/opensearch-go/compare/v2.2.0...v2.3.0

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![Go Reference](https://pkg.go.dev/badge/github.com/opensearch-project/opensearch-go.svg)](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3) [![Build](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml) [![Unit](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml) [![Integration](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml) [![codecov](https://codecov.io/gh/opensearch-project/opensearch-go/branch/main/graph/badge.svg?token=MI9g3KYHVx)](https://codecov.io/gh/opensearch-project/opensearch-go) [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/clients/) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
+[![Go Reference](https://pkg.go.dev/badge/github.com/opensearch-project/opensearch-go.svg)](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v4) [![Build](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/lint.yml) [![Unit](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-unit.yml) [![Integration](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml/badge.svg)](https://github.com/opensearch-project/opensearch-go/actions/workflows/test-integration.yml) [![codecov](https://codecov.io/gh/opensearch-project/opensearch-go/branch/main/graph/badge.svg?token=MI9g3KYHVx)](https://codecov.io/gh/opensearch-project/opensearch-go) [![Chat](https://img.shields.io/badge/chat-on%20forums-blue)](https://discuss.opendistrocommunity.dev/c/clients/) ![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
 
 ![OpenSearch logo](OpenSearch.svg)
 
@@ -20,7 +20,7 @@ OpenSearch Go Client
 - [Developer Guide](DEVELOPER_GUIDE.md)
 - [User Guide](USER_GUIDE.md)
 - [Documentation](https://opensearch.org/docs/latest/clients/go/)
-- [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v3)
+- [API Documentation](https://pkg.go.dev/github.com/opensearch-project/opensearch-go/v4)
 - Need help? Try [Forums](https://discuss.opendistrocommunity.dev/c/clients/)
 - [Project Principles](https://opensearch.org/#principles)
 - [Contributing to OpenSearch](CONTRIBUTING.md)

diff --git a/RELEASING.md b/RELEASING.md
@@ -34,7 +34,7 @@ Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v
 The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [MAINTAINERS](MAINTAINERS.md).
 
 1. Ensure that the version in [version.go](internal/version/version.go) is correct for the next release. 
-2. For major version releases, ensure that all references are up-to-date, e.g. `github.com/opensearch-project/opensearch-go/v3`, see [opensearch-go#444](https://github.com/opensearch-project/opensearch-go/pull/444).
+2. For major version releases, ensure that all references are up-to-date, e.g. `github.com/opensearch-project/opensearch-go/v4`, see [opensearch-go#444](https://github.com/opensearch-project/opensearch-go/pull/444).
 3. Edit the [CHANGELOG](CHANGELOG.md) and replace the `Unreleased` section with the version about to be released.
 4. Add a comparison link to the new version at the bottom of the [CHANGELOG](CHANGELOG.md).
 5. Create a pull request with the changes into `main`, e.g. [opensearch-go#443](https://github.com/opensearch-project/opensearch-go/pull/443).
@@ -57,4 +57,4 @@ The release process is standard across repositories in this org and is run by a
     ### Security
 
     ### Dependencies
-    ```
+    ```
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
@@ -23,9 +23,9 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchutil"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchutil"
 )
 
 const IndexName = "go-test-index1"
@@ -227,10 +227,10 @@ import (
 	"os"
 
 	"github.com/aws/aws-sdk-go/aws/session"
-	requestsigner "github.com/opensearch-project/opensearch-go/v3/signer/aws"
+	requestsigner "github.com/opensearch-project/opensearch-go/v4/signer/aws"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 const IndexName = "go-test-index1"
@@ -296,9 +296,9 @@ import (
 	"github.com/aws/aws-sdk-go-v2/aws"
 	"github.com/aws/aws-sdk-go-v2/config"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
-	requestsigner "github.com/opensearch-project/opensearch-go/v3/signer/awsv2"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
+	requestsigner "github.com/opensearch-project/opensearch-go/v4/signer/awsv2"
 )
 
 const endpoint = "" // e.g. https://opensearch-domain.region.com or Amazon OpenSearch Serverless endpoint

diff --git a/_samples/advanced_index_actions.go b/_samples/advanced_index_actions.go
@@ -13,8 +13,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/_samples/bulk.go b/_samples/bulk.go
@@ -14,8 +14,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/_samples/data_stream.go b/_samples/data_stream.go
@@ -14,8 +14,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/_samples/document_lifecycle.go b/_samples/document_lifecycle.go
@@ -14,8 +14,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/_samples/index_lifecycle.go b/_samples/index_lifecycle.go
@@ -14,8 +14,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/_samples/json.go b/_samples/json.go
@@ -13,8 +13,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 const IndexName = "go-test-index1"

diff --git a/_samples/search.go b/_samples/search.go
@@ -16,8 +16,8 @@ import (
 	"strings"
 	"time"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/error_test.go b/error_test.go
@@ -21,7 +21,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/opensearch-project/opensearch-go/v3"
+	"github.com/opensearch-project/opensearch-go/v4"
 )
 
 func TestError(t *testing.T) {

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/opensearch-project/opensearch-go/v3
+module github.com/opensearch-project/opensearch-go/v4
 
 go 1.21
 

diff --git a/guides/advanced_index_actions.md b/guides/advanced_index_actions.md
@@ -15,7 +15,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/bulk.md b/guides/bulk.md
@@ -16,7 +16,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/data_streams.md b/guides/data_streams.md
@@ -13,7 +13,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/document_lifecycle.md b/guides/document_lifecycle.md
@@ -15,7 +15,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/index_lifecycle.md b/guides/index_lifecycle.md
@@ -26,7 +26,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/index_template.md b/guides/index_template.md
@@ -17,8 +17,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/json.md b/guides/json.md
@@ -23,7 +23,7 @@ import (
 	"os"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/guides/search.md b/guides/search.md
@@ -16,7 +16,7 @@ import (
 	"strconv"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 func main() {

diff --git a/internal/test/helper.go b/internal/test/helper.go
@@ -20,8 +20,8 @@ import (
 	"github.com/stretchr/testify/require"
 	"github.com/wI2L/jsondiff"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 // NewClient returns an opensearchapi.Client that is adjusted for the wanted test case

diff --git a/internal/version/version.go b/internal/version/version.go
@@ -27,4 +27,4 @@
 package version
 
 // Client returns the client version as a string.
-const Client = "3.1.1"
+const Client = "4.0.0"
diff --git a/opensearch.go b/opensearch.go
@@ -41,9 +41,9 @@ import (
 	"strings"
 	"time"
 
-	"github.com/opensearch-project/opensearch-go/v3/internal/version"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
-	"github.com/opensearch-project/opensearch-go/v3/signer"
+	"github.com/opensearch-project/opensearch-go/v4/internal/version"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
+	"github.com/opensearch-project/opensearch-go/v4/signer"
 )
 
 const (

diff --git a/opensearch_benchmark_test.go b/opensearch_benchmark_test.go
@@ -37,8 +37,8 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
 )
 
 type FakeTransport struct {

diff --git a/opensearch_example_test.go b/opensearch_example_test.go
@@ -37,9 +37,9 @@ import (
 	"os"
 	"time"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
+	"github.com/opensearch-project/opensearch-go/v4"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
 )
 
 func init() {

diff --git a/opensearch_integration_test.go b/opensearch_integration_test.go
@@ -42,10 +42,10 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/opensearch-project/opensearch-go/v3"
-	ostest "github.com/opensearch-project/opensearch-go/v3/internal/test"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
+	"github.com/opensearch-project/opensearch-go/v4"
+	ostest "github.com/opensearch-project/opensearch-go/v4/internal/test"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
 )
 
 func TestClientTransport(t *testing.T) {

diff --git a/opensearch_internal_test.go b/opensearch_internal_test.go
@@ -43,7 +43,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/opensearch-project/opensearch-go/v3/opensearchtransport"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchtransport"
 )
 
 var called int

diff --git a/opensearchapi/api_aliases.go b/opensearchapi/api_aliases.go
@@ -11,7 +11,7 @@ import (
 	"io"
 	"net/http"
 
-	"github.com/opensearch-project/opensearch-go/v3"
+	"github.com/opensearch-project/opensearch-go/v4"
 )
 
 // Aliases executes an /_aliases request with the required AliasesReq

diff --git a/opensearchapi/api_aliases_test.go b/opensearchapi/api_aliases_test.go
@@ -14,9 +14,9 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	ostest "github.com/opensearch-project/opensearch-go/v3/internal/test"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
-	osapitest "github.com/opensearch-project/opensearch-go/v3/opensearchapi/internal/test"
+	ostest "github.com/opensearch-project/opensearch-go/v4/internal/test"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
+	osapitest "github.com/opensearch-project/opensearch-go/v4/opensearchapi/internal/test"
 )
 
 func TestAliases(t *testing.T) {

diff --git a/opensearchapi/api_bulk.go b/opensearchapi/api_bulk.go
@@ -12,7 +12,7 @@ import (
 	"net/http"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
+	"github.com/opensearch-project/opensearch-go/v4"
 )
 
 // Bulk executes a /_bulk request with the needed BulkReq

diff --git a/opensearchapi/api_bulk_test.go b/opensearchapi/api_bulk_test.go
@@ -16,9 +16,9 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	ostest "github.com/opensearch-project/opensearch-go/v3/internal/test"
-	"github.com/opensearch-project/opensearch-go/v3/opensearchapi"
-	osapitest "github.com/opensearch-project/opensearch-go/v3/opensearchapi/internal/test"
+	ostest "github.com/opensearch-project/opensearch-go/v4/internal/test"
+	"github.com/opensearch-project/opensearch-go/v4/opensearchapi"
+	osapitest "github.com/opensearch-project/opensearch-go/v4/opensearchapi/internal/test"
 )
 
 func TestBulkClient(t *testing.T) {

diff --git a/opensearchapi/api_cat-aliases.go b/opensearchapi/api_cat-aliases.go
@@ -10,7 +10,7 @@ import (
 	"net/http"
 	"strings"
 
-	"github.com/opensearch-project/opensearch-go/v3"
+	"github.com/opensearch-project/opensearch-go/v4"
 )
 
 // CatAliasesReq represent possible options for the /_cat/aliases request