elastic-enterprise-search 7.12.1 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc91758d4ef25ab3d509996223bf7c7cb07352e81f5f450fccadf8e0d799a4b
-  data.tar.gz: 646f6a1cb4295263a1dc3ee07441aa8c5bfe20b1692e5f0d970d31a2a14a41c4
+  metadata.gz: 6ebc1dd416a61d523f8de08fe29e3308539cce59a55a9edcbffc7997c85910d5
+  data.tar.gz: 2dd11f3198ee70cea2d7f9d76f4d411ee47160b5e4d0ba1a32080cc830301b5d
 SHA512:
-  metadata.gz: bddacbdbf0df0b8fe15197e4b3a016743dc7a79854d1de1bc9b5216c6297051808d905daae04c7d1da949840f971b4ad65dfc95b258db063a985380eaa66109c
-  data.tar.gz: 45e7a164a0ee32daa8968b87690c27eead9b3de83e5ae4e72fb7a9d6a496cd2fa4ec24dd696f666ac581c19d541e4cc978423f0b888f6611329b8c351b9408ed
+  metadata.gz: d9d5499b123c3d026d2c2dbde6a0a9952321c3b2befd12cd42199d3d032d26f65a02e371bc32ceb9a9f3bcb3c085e83aed2ad5b292b43aeed6bdf5db37878744
+  data.tar.gz: d212455f5c39d99eea502669241b4dbd848615e0de15109b764465d124b003696d0dd0737a276f294ac0ee9a17b56027dd711c6e1f1cd615aec09005bf30dadd

data/.ci/functions/imports.sh

@@ -19,6 +19,7 @@ if [[ -z $es_node_name ]]; then
   # only set these once
   set -euo pipefail
   export TEST_SUITE=${TEST_SUITE-free}
+  export SERVICE=${SERVICE-}
   export RUNSCRIPTS=${RUNSCRIPTS-}
   export DETACH=${DETACH-false}
   export CLEANUP=${CLEANUP-false}

data/.ci/jobs/defaults.yml

@@ -46,6 +46,10 @@
         type: yaml
         filename: .ci/test-matrix.yml
         name: RUBY_VERSION
+    - axis:
+        type: yaml
+        filename: .ci/test-matrix.yml
+        name: SERVICE
     yaml-strategy:
       exclude-key: exclude
       filename: .ci/test-matrix.yml

data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml

@@ -0,0 +1,12 @@
+---
+- job:
+    name: elastic+enterprise-search-ruby+7.10.0.beta.1
+    display-name: 'elastic / enterprise-search-ruby # 7.10.0.beta.1'
+    description: Testing the enterprise-search-ruby 7.10.0.beta.1 branch.
+    junit_results: "*-junit.xml"
+    parameters:
+    - string:
+        name: branch_specifier
+        default: refs/heads/7.10.0.beta.1
+        description: the Git branch specifier to build (<branchName>, <tagName>,
+          <commitId>, etc.)

data/.ci/jobs/{elastic+enterprise-search-ruby+7.11.yml → elastic+enterprise-search-ruby+main.yml}

@@ -1,12 +1,12 @@
 ---
 - job:
-    name: elastic+enterprise-search-ruby+7.11
-    display-name: 'elastic / enterprise-search-ruby # 7.11'
-    description: Testing the enterprise-search-ruby 7.11 branch.
+    name: elastic+enterprise-search-ruby+main
+    display-name: 'elastic / enterprise-search-ruby # main'
+    description: Testing the enterprise-search-ruby main branch.
     junit_results: "*-junit.xml"
     parameters:
     - string:
         name: branch_specifier
-        default: refs/heads/7.11
+        default: refs/heads/main
         description: the Git branch specifier to build (<branchName>, <tagName>,
           <commitId>, etc.)

data/.ci/make.sh

@@ -0,0 +1,162 @@
+#!/usr/bin/env bash
+
+# ------------------------------------------------------- #
+#
+# Skeleton for common build entry script for all elastic
+# clients. Needs to be adapted to individual client usage.
+#
+# Must be called: ./.ci/make.sh <target> <params>
+#
+# Version: 1.1.0
+#
+# Targets:
+# ---------------------------
+# assemble <VERSION> : build client artefacts with version
+# bump     <VERSION> : bump client internals to version
+# codegen  <VERSION> : generate endpoints
+# docsgen  <VERSION> : generate documentation
+# examplegen         : generate the doc examples
+# clean              : clean workspace
+#
+# ------------------------------------------------------- #
+
+# ------------------------------------------------------- #
+# Bootstrap
+# ------------------------------------------------------- #
+
+script_path=$(dirname "$(realpath -s "$0")")
+repo=$(realpath "$script_path/../")
+
+# shellcheck disable=SC1090
+CMD=$1
+TASK=$1
+TASK_ARGS=()
+VERSION=$2
+STACK_VERSION=$VERSION
+set -euo pipefail
+
+product="elastic/enterprise-search-ruby"
+output_folder=".ci/output"
+codegen_folder=".ci/output"
+OUTPUT_DIR="$repo/${output_folder}"
+REPO_BINDING="${OUTPUT_DIR}:/sln/${output_folder}"
+mkdir -p "$OUTPUT_DIR"
+
+echo -e "\033[34;1mINFO:\033[0m PRODUCT ${product}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m VERSION ${STACK_VERSION}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m OUTPUT_DIR ${OUTPUT_DIR}\033[0m"
+
+RUBY_TEST_VERSION=${RUBY_TEST_VERSION-2.7}
+
+case $CMD in
+    clean)
+        echo -e "\033[36;1mTARGET: clean workspace $output_folder\033[0m"
+        rm -rf "$output_folder"
+        echo -e "\033[32;1mdone.\033[0m"
+        exit 0
+        ;;
+    assemble)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: assemble -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: assemble artefact $VERSION\033[0m"
+        TASK=assemble
+        TASK_ARGS=("$VERSION" "$output_folder")
+        ;;
+    codegen)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: codegen -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: codegen API v$VERSION\033[0m"
+        TASK=codegen
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION" "$codegen_folder")
+        ;;
+    docsgen)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: docsgen -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: generate docs for $VERSION\033[0m"
+        TASK=codegen
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION" "$codegen_folder")
+        ;;
+    examplesgen)
+        echo -e "\033[36;1mTARGET: generate examples\033[0m"
+        TASK=codegen
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION" "$codegen_folder")
+        ;;
+    bump)
+        if [ -v $VERSION ]; then
+            echo -e "\033[31;1mTARGET: bump -> missing version parameter\033[0m"
+            exit 1
+        fi
+        echo -e "\033[36;1mTARGET: bump to version $VERSION\033[0m"
+        TASK=bump
+        # VERSION is BRANCH here for now
+        TASK_ARGS=("$VERSION")
+        ;;
+    *)
+        echo -e "\nUsage:\n\t $CMD is not supported right now\n"
+        exit 1
+esac
+
+
+# ------------------------------------------------------- #
+# Build Container
+# ------------------------------------------------------- #
+
+echo -e "\033[34;1mINFO: building $product container\033[0m"
+
+docker build --file .ci/Dockerfile --tag ${product} \
+  --build-arg USER_ID="$(id -u)" \
+  --build-arg GROUP_ID="$(id -g)" .
+
+
+# ------------------------------------------------------- #
+# Run the Container
+# ------------------------------------------------------- #
+
+echo -e "\033[34;1mINFO: running $product container\033[0m"
+
+# Convert ARGS to comma separated string for Rake:
+args_string="${TASK_ARGS[*]}"
+args_string="${args_string// /,}"
+
+docker run \
+       --env "RUBY_TEST_VERSION=${RUBY_TEST_VERSION}" \
+       --name test-runner \
+       --volume $REPO_BINDING \
+       --volume $repo:/usr/src/app \
+       --rm \
+       $product \
+       bundle exec rake unified_release:"$TASK"["$args_string"]
+
+# ------------------------------------------------------- #
+# Post Command tasks & checks
+# ------------------------------------------------------- #
+
+if [[ "$CMD" == "assemble" ]]; then
+	if compgen -G ".ci/output/*" > /dev/null; then
+		echo -e "\033[32;1mTARGET: successfully assembled client v$VERSION\033[0m"
+	else
+		echo -e "\033[31;1mTARGET: assemble failed, empty workspace!\033[0m"
+		exit 1
+	fi
+fi
+
+if [[ "$CMD" == "codegen" ]]; then
+    echo "TODO"
+fi
+
+if [[ "$CMD" == "docsgen" ]]; then
+    echo "TODO"
+fi
+
+if [[ "$CMD" == "examplesgen" ]]; then
+    echo "TODO"
+fi

data/.ci/run-repository.sh

@@ -17,6 +17,7 @@ echo -e "\033[34;1mINFO:\033[0m TEST_SUITE: ${TEST_SUITE}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m RUBY_VERSION: ${RUBY_VERSION}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m RUNSCRIPTS: ${RUNSCRIPTS}\033[0m"
 echo -e "\033[34;1mINFO:\033[0m URL: ${elasticsearch_url}\033[0m"
+echo -e "\033[34;1mINFO:\033[0m SERVICE: ${SERVICE}\033[0m"
 
 echo -e "\033[34;1mINFO:\033[0m pinging Elasticsearch ..\033[0m"
 curl --insecure --fail $external_elasticsearch_url/_cluster/health?pretty
@@ -46,4 +47,4 @@ docker run \
        --rm \
        --volume `pwd`:/code/enterprise-search-ruby \
        elastic/enterprise-search-ruby \
-       rake spec:integration
+       rake spec:integration:${SERVICE}

data/.ci/test-matrix.yml

@@ -6,9 +6,11 @@ RUBY_VERSION:
   - 2.5
 
 STACK_VERSION:
-  - 7.12-SNAPSHOT
+  - 7.15-SNAPSHOT
 
-TEST_SUITE:
-  - platinum
+SERVICE:
+  - appsearch
+  - enterprisesearch
+  - workplacesearch
 
 exclude: ~

data/{spec/app-search/api_logs_spec.rb → .github/check_license_headers.rb}

@@ -15,22 +15,19 @@
 # specific language governing permissions and limitations
 # under the License.
 
-# frozen_string_literal: true
+LICENSE = File.read('./.github/license-header.txt')
+files = `git ls-files | grep -E '\.rb|Rakefile|\.rake|\.erb|Gemfile|gemspec'`.split("\n")
+errors = []
 
-require_relative './api_spec_helper'
-
-describe Elastic::EnterpriseSearch::AppSearch::Client do
-  context 'api_logs' do
-    it 'returns api logs' do
-      VCR.use_cassette('app_search/api_logs') do
-        response = @client.api_logs(
-          'videogames',
-          from_date: Date.new(2020, 10, 0o1),
-          to_date: Date.new(2020, 11, 0o5)
-        )
-        expect(response.status).to eq 200
-        expect(response.body['results'].count).to be > 1
-      end
-    end
+files.each do |file|
+  unless File.read(file).include?(LICENSE)
+    errors << file
+    puts "#{file} doesn't contain the correct license header"
   end
 end
+
+if errors.empty?
+  puts 'All checked files have the correct license header'
+else
+  exit 1
+end

data/.github/license-header.txt

@@ -0,0 +1,16 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

data/.github/workflows/license.yml

@@ -0,0 +1,13 @@
+name: License headers
+on: [pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3
+    - name: Check license headers
+      run: |
+        ruby ./.github/check_license_headers.rb

data/.github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: master
+name: 7.15
 on: [push, pull_request]
 
 jobs:

data/CONTRIBUTING.md

@@ -22,7 +22,7 @@
 
 3. Rebase your changes. Update your local repository with the most recent code
    from the main `enterprise-search-ruby` repository and rebase your branch
-   on top of the latest `master` branch. All of your changes will be squashed
+   on top of the latest `main` branch. All of your changes will be squashed
    into a single commit so don't worry about pushing multiple times.
    
 4. Submit a pull request. Push your local changes to your forked repository

data/README.md

@@ -1,6 +1,6 @@
 # Elastic Enterprise Search Client
 
-![build](https://github.com/elastic/enterprise-search-ruby/workflows/master/badge.svg)
+![build](https://github.com/elastic/enterprise-search-ruby/workflows/main/badge.svg)
 ![rubocop](https://github.com/elastic/enterprise-search-ruby/workflows/rubocop/badge.svg)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
 

data/Rakefile

@@ -19,6 +19,7 @@
 
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
+import 'rake_tasks/unified_release_tasks.rake'
 
 desc 'Open an irb session preloaded with this library'
 task :console do
@@ -30,6 +31,7 @@ task :stack, [:version] do |_, params|
   sh "STACK_VERSION=#{params[:version]} ./.ci/run-local.sh"
 end
 
+# rubocop:disable Metrics/BlockLength
 namespace :spec do
   desc 'Run client tests'
   task :client do
@@ -45,4 +47,22 @@ namespace :spec do
   task :all do
     sh 'rspec spec'
   end
+
+  namespace :integration do
+    desc 'Run App Search integration tests'
+    task :appsearch do
+      sh 'rspec spec/integration/app-search'
+    end
+
+    desc 'Run Enterprise Search integration tests'
+    task :enterprisesearch do
+      sh 'rspec spec/integration/enterprise_search_api_spec.rb'
+    end
+
+    desc 'Run Workplace Search integration tests'
+    task :workplacesearch do
+      sh 'rspec spec/integration/workplace-search'
+    end
+  end
 end
+# rubocop:enable Metrics/BlockLength

data/docs/guide/app-search-api.asciidoc

@@ -1,6 +1,8 @@
 [[app-search-api]]
 == App Search API
 
+This document includes examples for different API requests. Please refer to the https://www.elastic.co/guide/en/app-search/current/index.html[Elastic App Search Documentation] for more information, particularly the https://www.elastic.co/guide/en/app-search/current/api-reference.html[API Reference].
+
 === Engines
 
 [source,rb]
@@ -146,6 +148,160 @@ client.list_curations(engine_name)
 client.delete_curation(engine_name, curation_id: 'cur-id')
 ----------------------------
 
+=== Api Key
+
+[source,rb]
+----------------------------
+# Create API Key
+body = {
+  name: name,
+  type: 'private',
+  read: true,
+  write: true,
+  access_all_engines: true
+}
+response = client.create_api_key(body: body)
+
+# Get the details of an API Key
+client.api_key(api_key_name: name)
+
+# List API Keys
+client.list_api_keys
+
+# Update an API Key
+body = { name: name, type: 'private', read: true, write: true, engines: ['test'] }
+client.put_api_key(api_key_name: name, body: body)
+
+# Delete an API Key
+client.delete_api_key(api_key_name: name)
+----------------------------
+
+=== Web Crawler
+
+[CAUTION]
+====
+The Elastic Enterprise Search web crawler API is a *beta* feature.
+Beta features are subject to change and are not covered by the support SLA of general release (GA) features.
+Elastic plans to promote this feature to GA in a future release.
+====
+
+See https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html[Web Crawler API reference] for more information.
+
+[source,rb]
+----------------------------
+# Create a crawler domain
+body = { name: 'https://www.elastic.co' }
+client.create_crawler_domain(engine_name, body: body)
+
+# Get crawler domain information
+client.crawler_domain(engine_name, domain_id: domain_id)
+
+# Update a crawler domain
+body = { name: 'https://www.wikipedia.org' }
+client.put_crawler_domain(engine_name, domain_id: domain_id, domain: body)
+
+# Delete a crawler domain
+client.delete_crawler_domain(engine_name, domain_id: domain_id)
+
+# Create a crawler crawl request
+client.create_crawler_crawl_request(engine_name)
+
+# Retrieve a crawl request
+client.crawler_crawl_request(engine_name, crawl_request_id: request_id)
+
+# Retrieve active crawl request details
+client.crawler_active_crawl_request(engine_name)
+
+# List crawl requests
+client.list_crawler_crawl_requests(engine_name)
+
+# Delete an active crawl request
+client.delete_active_crawl_request(engine_name)
+
+# Set a crawler crawl schedule
+body = { frequency: 1, unit: 'day' }
+client.put_crawler_crawl_schedule(engine_name, body: body)
+
+# Retrieve crawler crawl schedule
+client.crawler_crawl_schedule(engine_name)
+
+# Delete a crawler crawl schedule
+client.delete_crawler_crawl_schedule(engine_name)
+
+# Create a crawler entry point
+client.create_crawler_entry_point(engine_name, domain_id: domain_id, body: { value: '/elastic-stack' })
+
+# Update a crawler entry point
+client.put_crawler_entry_point(
+  engine_name,
+  domain_id: domain_id,
+  entry_point_id: entry_point_id,
+  body: { value: '/enterprise-search' }
+)
+
+# Validate a URL
+client.crawler_url_validation_result(engine_name,  url: name)
+
+# Extract ccontent from a URL
+client.crawler_url_extraction_result(engine_name, url: name)
+
+# Retrieve tracing history for a crawler URL
+client.crawler_url_tracing_result(engine_name, url: name)
+
+# Delete a crawler entry point
+client.delete_crawler_entry_point(
+  engine_name,
+  domain_id: domain_id,
+  entry_point_id: entry_point_id
+)
+
+# Retrieve crawler metrics
+client.crawler_metrics
+
+# Retrieve crawler configuration overview
+client.crawler_overview(engine_name)
+
+# Create a crawler sitemap
+body = { url: 'https://www.elastic.co/sitemap.xml' }
+client.create_crawler_sitemap(engine_name, domain_id: domain_id, body: body)
+
+# Update a crawler sitemap
+body = { url: 'https://www.elastic.co/sitemap2.xml' }
+client.put_crawler_sitemap(engine_name, domain_id: domain_id, sitemap_id: sitemap_id, body: body)
+
+# Delete a crawler sitemap
+client.delete_crawler_sitemap(engine_name, domain_id: domain_id, sitemap_id: sitemap_id)
+
+# Create a crawler crawl rule
+body = { order: 1, policy: 'allow', rule: 'contains', pattern: '/stack' }
+client.create_crawler_crawl_rule(engine_name, domain_id: domain_id, body: body)
+
+# Update a crawler crawl rule
+body = { order: 2, policy: 'allow', rule: 'begins', pattern: '/stack' }
+client.put_crawler_crawl_rule(engine_name, domain_id: domain_id, crawl_rule_id: rule_id, body: body)
+
+# Delete a crawler crawl rule
+client.delete_crawler_crawl_rule(engine_name, domain_id: domain_id, crawl_rule_id: rule_id)
+
+# Create a process crawl
+client.create_crawler_process_crawl(engine_name, body: { dry_run: true })
+
+# Retrieve a process crawl
+client.crawler_process_crawl(engine_name, process_crawl_id: id)
+
+# Retrieve denied URLs cor a process crawl
+client.denied_urls(engine_name, process_crawl_id: id)
+
+# List process crawls
+client.list_crawler_process_crawls(engine_name)
+
+# View denied urls for Process Crawl
+client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
+
+# Cancel an active crawl request, stopping a running crawl if needed.
+client.delete_crawler_active_crawl_request(engine_name)
+----------------------------
+
 === Other API Endpoints
 
 [source,rb]
@@ -179,7 +335,7 @@ client.put_search_settings(engine_name, body: body)
 client.reset_search_settings(engine_name)
 
 # Click - Send data about clicked results
-client.log_clickthrough(engine_name, query_text: 'query', document_id: 'doc-id')
+client.log_clickthrough(engine_name, body: { query: 'query', document_id: 'doc-id' })
 
 # Query Suggestion - Provide relevant query suggestions for incomplete queries
 client.query_suggestion(engine_name, query: 'incomplete_query')

data/docs/guide/connecting.asciidoc

@@ -87,7 +87,13 @@ client.search(engine_name, query: 'jungle')
 [[auth-ws]]
 ==== Authenticating with Workplace Search
 
-In your Elastic Workplace Search dashboard navigate to _Sources/Add a Shared Content Source_ and select _Custom API Source_ to create a new source. Name your source (e.g. `Enterprise Search Ruby Client`) and once it's created you'll get an `access token` and an `ID`. You'll need these in the following steps.
+Workplace Search supports multiple authentication methods:
+
+[discrete]
+[[access-tokens]]
+===== Workplace Search admin user access tokens
+
+In your Elastic Workplace Search dashboard navigate to _Sources/Add a Shared Content Source_ and select _Custom API Source_ to create a new source. Name your source (e.g. `Enterprise Search Ruby Client`) and once it's created you'll get an `access token` and an `ID`.
 
 The Workplace Search client can be accessed from an existing Enterprise Search Client, or you can initialize a new one. If you instantiate the Workplace Search client from an existing Enterprise Search Client, it's going to share the HTTP transport instance, so it's going to connect to the same host, which is a common scenario. However, if you want to connect to a different host, you should instantiate a new Workplace Client on its own:
 
@@ -109,6 +115,46 @@ workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new
 )
 ----------------------------
 
+[discrete]
+[[basic-auth]]
+===== Basic Authentication
+
+Workplace Search APIs support basic authentication headers to authenticate users. All Workplace Search APIs support basic authentication:
+
+[source,rb]
+----------------------------
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+basic_auth = { user: 'enterprise_search', password: 'changeme' }
+
+workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+  host: host,
+  http_auth: basic_auth
+)
+----------------------------
+
+[discrete]
+[[es-tokens]]
+===== Elasticsearch tokens
+
+Workplace Search APIs support Elasticsearch tokens generated by the Elasticsearch Token Service. All Workplace Search APIs support Elasticsearch tokens as an authentication method.
+
+[source,rb]
+----------------------------
+host = 'https://id.ent-search.europe-west2.gcp.elastic-cloud.com'
+access_token = '<access token>'
+
+workplace_search_client = Elastic::EnterpriseSearch::WorkplaceSearch::Client.new(
+  host: host,
+  http_auth: access_token
+)
+----------------------------
+
+[discrete]
+[[ws-oauth]]
+===== Workplace Search OAuth access tokens
+
+The Search API and the Analytics Events API support user access tokens generated by the Workplace Search OAuth Service. The token is acquired via an OAuth authorization flow. User access tokens are meant to be used for Custom Search Experiences. Check <<ws-oauth-authentication>>.
+
 [discrete]
 [[custom_headers]]
 === Custom HTTP Headers

data/docs/guide/overview.asciidoc

@@ -6,7 +6,7 @@ This is the official Ruby client for Elastic Enterprise Search.
 [discrete]
 === Compatibility
 
-Current development happens in the master branch.
+Current development happens in the main branch.
 
 The library is compatible with all Elastic Enterprise Search versions since `7.x` but you **have to use a matching major version**:
 
@@ -14,11 +14,11 @@ For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y
 
 [discrete]
 === HTTP Library
-This library uses https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-transport[elasticsearch-transport], the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client].
+This library uses https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport[elasticsearch-transport], the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official https://github.com/elastic/elasticsearch-ruby[Elasticsearch Ruby Client].
 
 All requests, if successful, will return an `Elasticsearch::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
 
-`elasticsearch-transport` defines a https://github.com/elasticsearch/elasticsearch-ruby/blob/master/elasticsearch-transport/lib/elasticsearch/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elasticsearch-ruby/tree/master/elasticsearch-transport#exception-handling[here]. You can find the full documentation for `elasticsearch-transport` at https://rubydoc.info/gems/elasticsearch-transport[RubyDoc].
+`elasticsearch-transport` defines a https://github.com/elasticsearch/elasticsearch-ruby/blob/main/elasticsearch-transport/lib/elasticsearch/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-transport#exception-handling[here]. You can find the full documentation for `elasticsearch-transport` at https://rubydoc.info/gems/elasticsearch-transport[RubyDoc].
 
 The clients pass different options to transport, you can check them out https://rubydoc.info/github/elastic/enterprise-search-ruby/Elastic/EnterpriseSearch/Client[on RubyDocs].
 

data/docs/guide/release_notes/712.asciidoc

@@ -26,13 +26,3 @@
 
 - Updates source code documentation for `current_page` and `page_size` parameters from type `String` to `Integer`.
 - In `multi_search`, the body parameter is renamed to `body` from `queries` to avoid repetition and potential confusion.
-
-[discrete]
-==== Workplace Search
-
-- Body parameter renamed to `document_ids` in `delete_documents`:
-
-[source,rb]
-----------------------------
-client.delete_documents(content_source_id, document_ids: ['e68fbc2688f1', 'c535e226aee3'])
-----------------------------