Clean up

* Fix documentation links, typos and other minor annoyances * Add .gometalinter.json
veqryn · Mar 24, 2018 · ffff59e · ffff59e
1 parent 614e037
commit ffff59e
Show file tree

Hide file tree

Showing 149 changed files with 337 additions and 280 deletions.
diff --git a/.gometalinter.json b/.gometalinter.json
@@ -0,0 +1,37 @@
+{
+  "Vendor": false,
+  "Deadline": "2m",
+  "Sort": ["linter", "severity", "path", "line"],
+  "DisableAll": true,
+  "Enable": [
+    "deadcode",
+    "dupl",
+    "gocyclo",
+    "gofmt",
+    "goimports",
+    "golint",
+    "gosimple",
+    "ineffassign",
+    "interfacer",
+    "lll",
+    "megacheck",
+    "misspell",
+    "nakedret",
+    "structcheck",
+    "unconvert",
+    "unparam",
+    "unused",
+    "varcheck",
+    "vet"
+  ],
+  "EnableGC": true,
+  "WarnUnmatchedDirective": true,
+  "Cyclo": 24,
+  "LineLength": 200,
+  "Exclude": [
+    "generator",
+    "spec",
+    "tmp",
+    ".*_easyjson.go"
+  ]
+}
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ import "github.com/olivere/elastic"
 
 Elastic 6.0 targets Elasticsearch 6.x which was [released on 14th November 2017](https://www.elastic.co/blog/elasticsearch-6-0-0-released).
 
-Notice that there are will be a lot of [breaking changes in Elasticsearch 6.0](https://www.elastic.co/guide/en/elasticsearch/reference/6.0/breaking-changes-6.0.html)
+Notice that there are will be a lot of [breaking changes in Elasticsearch 6.0](https://www.elastic.co/guide/en/elasticsearch/reference/6.2/breaking-changes-6.0.html)
 and we used this as an opportunity to [clean up and refactor Elastic](https://github.com/olivere/elastic/blob/release-branch.v6/CHANGELOG-6.0.md)
 as we did in the transition from earlier versions of Elastic.
 

diff --git a/bulk.go b/bulk.go
@@ -23,7 +23,7 @@ import (
 // reuse BulkService to send many batches. You do not have to create a new
 // BulkService for each batch.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for more details.
 type BulkService struct {
 	client  *Client

diff --git a/bulk_delete_request.go b/bulk_delete_request.go
@@ -16,7 +16,7 @@ import (
 
 // BulkDeleteRequest is a request to remove a document from Elasticsearch.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for details.
 type BulkDeleteRequest struct {
 	BulkableRequest
@@ -128,7 +128,7 @@ func (r *BulkDeleteRequest) String() string {
 
 // Source returns the on-wire representation of the delete request,
 // split into an action-and-meta-data line and an (optional) source line.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for details.
 func (r *BulkDeleteRequest) Source() ([]string, error) {
 	if r.source != nil {

diff --git a/bulk_index_request.go b/bulk_index_request.go
@@ -14,7 +14,7 @@ import (
 
 // BulkIndexRequest is a request to add a document to Elasticsearch.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for details.
 type BulkIndexRequest struct {
 	BulkableRequest
@@ -95,7 +95,7 @@ func (r *BulkIndexRequest) Id(id string) *BulkIndexRequest {
 
 // OpType specifies if this request should follow create-only or upsert
 // behavior. This follows the OpType of the standard document index API.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-index_.html#operation-type
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-index_.html#operation-type
 // for details.
 func (r *BulkIndexRequest) OpType(opType string) *BulkIndexRequest {
 	r.opType = opType
@@ -128,7 +128,7 @@ func (r *BulkIndexRequest) Version(version int64) *BulkIndexRequest {
 // VersionType specifies how versions are created. It can be e.g. internal,
 // external, external_gte, or force.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-index_.html#index-versioning
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-index_.html#index-versioning
 // for details.
 func (r *BulkIndexRequest) VersionType(versionType string) *BulkIndexRequest {
 	r.versionType = versionType
@@ -169,7 +169,7 @@ func (r *BulkIndexRequest) String() string {
 
 // Source returns the on-wire representation of the index request,
 // split into an action-and-meta-data line and an (optional) source line.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for details.
 func (r *BulkIndexRequest) Source() ([]string, error) {
 	// { "index" : { "_index" : "test", "_type" : "type1", "_id" : "1" } }

diff --git a/bulk_update_request.go b/bulk_update_request.go
@@ -14,7 +14,7 @@ import (
 
 // BulkUpdateRequest is a request to update a document in Elasticsearch.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for details.
 type BulkUpdateRequest struct {
 	BulkableRequest
@@ -120,8 +120,8 @@ func (r *BulkUpdateRequest) Parent(parent string) *BulkUpdateRequest {
 }
 
 // Script specifies an update script.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html#bulk-update
-// and https://www.elastic.co/guide/en/elasticsearch/reference/6.0/modules-scripting.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html#bulk-update
+// and https://www.elastic.co/guide/en/elasticsearch/reference/6.2/modules-scripting.html
 // for details.
 func (r *BulkUpdateRequest) Script(script *Script) *BulkUpdateRequest {
 	r.script = script
@@ -132,7 +132,7 @@ func (r *BulkUpdateRequest) Script(script *Script) *BulkUpdateRequest {
 // ScripedUpsert specifies if your script will run regardless of
 // whether the document exists or not.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-update.html#_literal_scripted_upsert_literal
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-update.html#_literal_scripted_upsert_literal
 func (r *BulkUpdateRequest) ScriptedUpsert(upsert bool) *BulkUpdateRequest {
 	r.scriptedUpsert = &upsert
 	r.source = nil
@@ -172,7 +172,7 @@ func (r *BulkUpdateRequest) Doc(doc interface{}) *BulkUpdateRequest {
 // DocAsUpsert indicates whether the contents of Doc should be used as
 // the Upsert value.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-update.html#_literal_doc_as_upsert_literal
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-update.html#_literal_doc_as_upsert_literal
 // for details.
 func (r *BulkUpdateRequest) DocAsUpsert(docAsUpsert bool) *BulkUpdateRequest {
 	r.docAsUpsert = &docAsUpsert
@@ -218,7 +218,7 @@ func (r *BulkUpdateRequest) String() string {
 
 // Source returns the on-wire representation of the update request,
 // split into an action-and-meta-data line and an (optional) source line.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-bulk.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-bulk.html
 // for details.
 func (r *BulkUpdateRequest) Source() ([]string, error) {
 	// { "update" : { "_index" : "test", "_type" : "type1", "_id" : "1", ... } }

diff --git a/clear_scroll.go b/clear_scroll.go
@@ -12,7 +12,7 @@ import (
 
 // ClearScrollService clears one or more scroll contexts by their ids.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-request-scroll.html#_clear_scroll_api
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-scroll.html#_clear_scroll_api
 // for details.
 type ClearScrollService struct {
 	client   *Client

diff --git a/client.go b/client.go
@@ -26,7 +26,7 @@ import (
 
 const (
 	// Version is the current version of Elastic.
-	Version = "6.1.12"
+	Version = "6.1.13"
 
 	// DefaultURL is the default endpoint of Elasticsearch on the local machine.
 	// It is used e.g. when initializing a new Client without a specific URL.
@@ -154,7 +154,7 @@ type Client struct {
 //
 // If the sniffer is enabled (the default), the new client then sniffes
 // the cluster via the Nodes Info API
-// (see https://www.elastic.co/guide/en/elasticsearch/reference/6.0/cluster-nodes-info.html#cluster-nodes-info).
+// (see https://www.elastic.co/guide/en/elasticsearch/reference/6.2/cluster-nodes-info.html#cluster-nodes-info).
 // It uses the URLs specified by the caller. The caller is responsible
 // to only pass a list of URLs of nodes that belong to the same cluster.
 // This sniffing process is run on startup and periodically.
@@ -1383,7 +1383,7 @@ func (c *Client) BulkProcessor() *BulkProcessorService {
 
 // Reindex copies data from a source index into a destination index.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-reindex.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-reindex.html
 // for details on the Reindex API.
 func (c *Client) Reindex() *ReindexService {
 	return NewReindexService(c)

diff --git a/cluster_state.go b/cluster_state.go
@@ -15,7 +15,7 @@ import (
 
 // ClusterStateService allows to get a comprehensive state information of the whole cluster.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/cluster-state.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/cluster-state.html
 // for details.
 type ClusterStateService struct {
 	client            *Client

diff --git a/cluster_stats.go b/cluster_stats.go
@@ -14,7 +14,7 @@ import (
 )
 
 // ClusterStatsService is documented at
-// https://www.elastic.co/guide/en/elasticsearch/reference/6.0/cluster-stats.html.
+// https://www.elastic.co/guide/en/elasticsearch/reference/6.2/cluster-stats.html.
 type ClusterStatsService struct {
 	client       *Client
 	pretty       bool

diff --git a/delete.go b/delete.go
@@ -16,7 +16,7 @@ import (
 // DeleteService allows to delete a typed JSON document from a specified
 // index based on its id.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-delete.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-delete.html
 // for details.
 type DeleteService struct {
 	client              *Client

diff --git a/delete_by_query.go b/delete_by_query.go
@@ -14,7 +14,7 @@ import (
 )
 
 // DeleteByQueryService deletes documents that match a query.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-delete-by-query.html.
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-delete-by-query.html.
 type DeleteByQueryService struct {
 	client                 *Client
 	index                  []string

diff --git a/exists.go b/exists.go
@@ -15,7 +15,7 @@ import (
 
 // ExistsService checks for the existence of a document using HEAD.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-get.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-get.html
 // for details.
 type ExistsService struct {
 	client     *Client

diff --git a/explain.go b/explain.go
@@ -15,7 +15,7 @@ import (
 
 // ExplainService computes a score explanation for a query and
 // a specific document.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-explain.html.
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-explain.html.
 type ExplainService struct {
 	client                 *Client
 	pretty                 bool

diff --git a/fetch_source_context.go b/fetch_source_context.go
@@ -14,7 +14,7 @@ import (
 // with various endpoints, e.g. when searching for documents, retrieving
 // individual documents, or even updating documents.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-request-source-filtering.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-source-filtering.html
 // for details.
 type FetchSourceContext struct {
 	fetchSource bool

diff --git a/field_caps.go b/field_caps.go
@@ -16,7 +16,7 @@ import (
 
 // FieldCapsService allows retrieving the capabilities of fields among multiple indices.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.1/search-field-caps.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-field-caps.html
 // for details
 type FieldCapsService struct {
 	client            *Client

diff --git a/get.go b/get.go
@@ -17,7 +17,7 @@ import (
 // GetService allows to get a typed JSON document from the index based
 // on its id.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-get.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-get.html
 // for details.
 type GetService struct {
 	client                        *Client

diff --git a/highlight.go b/highlight.go
@@ -6,7 +6,7 @@ package elastic
 
 // Highlight allows highlighting search results on one or more fields.
 // For details, see:
-// https://www.elastic.co/guide/en/elasticsearch/reference/6.0/search-request-highlighting.html
+// https://www.elastic.co/guide/en/elasticsearch/reference/6.2/search-request-highlighting.html
 type Highlight struct {
 	fields                []*HighlighterField
 	tagsSchema            *string

diff --git a/index.go b/index.go
@@ -15,7 +15,7 @@ import (
 // IndexService adds or updates a typed JSON document in a specified index,
 // making it searchable.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-index_.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-index_.html
 // for details.
 type IndexService struct {
 	client              *Client
@@ -175,7 +175,7 @@ func (s *IndexService) buildURL() (string, string, url.Values, error) {
 		})
 	} else {
 		// Automatic ID generation
-		// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/docs-index_.html#index-creation
+		// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/docs-index_.html#index-creation
 		method = "POST"
 		path, err = uritemplates.Expand("/{index}/{type}/", map[string]string{
 			"index": s.index,

diff --git a/indices_analyze.go b/indices_analyze.go
@@ -15,7 +15,7 @@ import (
 // IndicesAnalyzeService performs the analysis process on a text and returns
 // the tokens breakdown of the text.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-analyze.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-analyze.html
 // for detail.
 type IndicesAnalyzeService struct {
 	client      *Client
@@ -185,7 +185,7 @@ func (s *IndicesAnalyzeService) Do(ctx context.Context) (*IndicesAnalyzeResponse
 	} else {
 		// Request parameters are deprecated in 5.1.1, and we must use a JSON
 		// structure in the body to pass the parameters.
-		// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-analyze.html
+		// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-analyze.html
 		body = s.request
 	}
 

diff --git a/indices_close.go b/indices_close.go
@@ -14,7 +14,7 @@ import (
 
 // IndicesCloseService closes an index.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-open-close.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-open-close.html
 // for details.
 type IndicesCloseService struct {
 	client            *Client

diff --git a/indices_create.go b/indices_create.go
@@ -14,7 +14,7 @@ import (
 
 // IndicesCreateService creates a new index.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-create-index.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-create-index.html
 // for details.
 type IndicesCreateService struct {
 	client        *Client

diff --git a/indices_delete.go b/indices_delete.go
@@ -15,7 +15,7 @@ import (
 
 // IndicesDeleteService allows to delete existing indices.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-delete-index.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-delete-index.html
 // for details.
 type IndicesDeleteService struct {
 	client        *Client

diff --git a/indices_delete_template.go b/indices_delete_template.go
@@ -13,7 +13,7 @@ import (
 )
 
 // IndicesDeleteTemplateService deletes index templates.
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-templates.html.
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-templates.html.
 type IndicesDeleteTemplateService struct {
 	client        *Client
 	pretty        bool

diff --git a/indices_exists.go b/indices_exists.go
@@ -16,7 +16,7 @@ import (
 
 // IndicesExistsService checks if an index or indices exist or not.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-exists.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-exists.html
 // for details.
 type IndicesExistsService struct {
 	client            *Client

diff --git a/indices_exists_type.go b/indices_exists_type.go
@@ -16,7 +16,7 @@ import (
 
 // IndicesExistsTypeService checks if one or more types exist in one or more indices.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-types-exists.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-types-exists.html
 // for details.
 type IndicesExistsTypeService struct {
 	client            *Client

diff --git a/indices_flush.go b/indices_flush.go
@@ -17,7 +17,7 @@ import (
 // basically frees memory from the index by flushing data to the index
 // storage and clearing the internal transaction log.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-flush.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-flush.html
 // for details.
 type IndicesFlushService struct {
 	client            *Client

diff --git a/indices_get.go b/indices_get.go
@@ -15,7 +15,7 @@ import (
 
 // IndicesGetService retrieves information about one or more indices.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-get-index.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-get-index.html
 // for more details.
 type IndicesGetService struct {
 	client            *Client

diff --git a/indices_get_field_mapping.go b/indices_get_field_mapping.go
@@ -16,7 +16,7 @@ import (
 // IndicesGetFieldMappingService retrieves the mapping definitions for the fields in an index
 //  or index/type.
 //
-// See https://www.elastic.co/guide/en/elasticsearch/reference/6.0/indices-get-field-mapping.html
+// See https://www.elastic.co/guide/en/elasticsearch/reference/6.2/indices-get-field-mapping.html
 // for details.
 type IndicesGetFieldMappingService struct {
 	client            *Client