elastic-enterprise-search 7.14.0 → 7.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1eef7550b4a936e514eb9b0eb52272a2b445b3e54c301c7cec29039c789561ee
-  data.tar.gz: 47ab2fcbb9b00a3cbb219e713ee9308642345b72dcc6af5b9f0f1f334edd7c09
+  metadata.gz: 6ebc1dd416a61d523f8de08fe29e3308539cce59a55a9edcbffc7997c85910d5
+  data.tar.gz: 2dd11f3198ee70cea2d7f9d76f4d411ee47160b5e4d0ba1a32080cc830301b5d
 SHA512:
-  metadata.gz: 38a4519bfa5d4b3ea04507468b0c5ddb7122d8c5c928943b45d3d1ce120d3a1652ac7c2aff217082aaca4cdc3124b732e4f31c265bf5c6f0cdc0173672e020f0
-  data.tar.gz: 7cd26fe0a7fc874ccbcfb16ef443d5c9ddd69b0a882690dcbfc0b90d698a10bd89d942530ba93aae78531cddc6960721edd8d2a410728be87aacd018e1aeed31
+  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+master.yml → elastic+enterprise-search-ruby+main.yml}

@@ -1,12 +1,12 @@
 ---
 - job:
-    name: elastic+enterprise-search-ruby+master
-    display-name: 'elastic / enterprise-search-ruby # master'
-    description: Testing the enterprise-search-ruby master 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/master
+        default: refs/heads/main
         description: the Git branch specifier to build (<branchName>, <tagName>,
           <commitId>, etc.)

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.14-SNAPSHOT
+  - 7.15-SNAPSHOT
 
-TEST_SUITE:
-  - platinum
+SERVICE:
+  - appsearch
+  - enterprisesearch
+  - workplacesearch
 
 exclude: ~

data/.github/workflows/testing.yml

@@ -1,4 +1,4 @@
-name: 7.14
+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

@@ -31,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
@@ -46,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]
@@ -174,6 +176,132 @@ client.put_api_key(api_key_name: name, body: body)
 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]
@@ -207,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/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/715.asciidoc

@@ -0,0 +1,36 @@
+[[release_notes_715]]
+=== 7.15.0 Release notes
+
+[discrete]
+==== General
+
+- Tested with Elastic Enterprise Search API version 7.15.0.
+- Better source code documentation in general for API endpoints.
+
+[discrete]
+==== App Search
+
+- The test suite was migrated to full integration testing https://clients-ci.elastic.co/view/Ruby/[in Jenkins]. We were using VCR for testing the API, but now we're running the API tests against an instance of Elastic Enterprise Search.
+
+- Some APIs that used to work with `GET` query parameters in App Search are now `POST` and the parameters being sent with the body. We'll use the body from `7.15`, but we'll keep supporting arguments parameters in 7.x for backwards compatibility. Some parameters previously required through the generated code don't throw an exception anymore and the error is delegated to server. As mentioned, these should go through the body instead of part of the query parameters, but we still support sending them as query parameters in `7.x` to keep backwards compatibility.
+
+[discrete]
+===== Web Crawler API
+
+[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.
+====
+
+New Web Crawler API endpoints:
+
+`crawler_active_crawl_request`, `crawler_crawl_request`, `crawler_crawl_schedule`, `crawler_domain`, `crawler_domain_validation_result`, `crawler_metrics`, `crawler_overview`, `crawler_process_crawl_denied_urls`, `crawler_process_crawl`, `crawler_url_extraction_result`, `crawler_url_tracing_result`, `crawler_url_validation_result`, `crawler_user_agent`, `create_crawler_crawl_request`, `create_crawler_crawl_rule`, `create_crawler_domain`, `create_crawler_entry_point`, `create_crawler_process_crawl`, `create_crawler_sitemap`, `delete_active_crawl_request`, `delete_crawler_active_crawl_request`, `delete_crawler_crawl_rule`, `delete_crawler_crawl_schedule`, `delete_crawler_domain`, `delete_crawler_entry_point`, `delete_crawler_sitemap`, `list_crawler_crawl_requests`, `list_crawler_process_crawls`, `put_crawler_crawl_rule`, `put_crawler_crawl_schedule`, `put_crawler_domain`, `put_crawler_entry_point`, `put_crawler_sitemap`.
+
+Refer to https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/app-search-api.html[App Search API] for more information and examples.
+
+[discrete]
+==== Workplace Search
+
+- New APIs: `auto_query_refinement_details`, `triggers_blocklist` and `put_triggers_blocklist`. See https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/workplace-search-api.html[Workplace Search API] for more information and examples.

data/docs/guide/release_notes/index.asciidoc

@@ -5,12 +5,14 @@
 [discrete]
 === 7.x
 
+* <<release_notes_715, 7.15.0 Release Notes>>
 * <<release_notes_714, 7.14.0 Release Notes>>
 * <<release_notes_713, 7.13.0 Release Notes>>
 * <<release_notes_712, 7.12.0 Release Notes>>
 * <<release_notes_711, 7.11.0 Release Notes>>
 * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
 
+include::715.asciidoc[]
 include::714.asciidoc[]
 include::713.asciidoc[]
 include::712.asciidoc[]

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

@@ -37,6 +37,9 @@ require 'base64'
 path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
 icon = Base64.strict_encode64(File.read(path))
 response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
+
+# Retrieves a content source's automatic query refinement details
+client.auto_query_refinement_details(content_source_id)
 ----------------------------
 
 === Documents
@@ -218,3 +221,14 @@ client.current_user
 # Get the current user and return the access token
 client.current_user(get_token: true)
 ----------------------------
+
+=== Triggers Blocklist
+
+[source,rb]
+----------------------------
+# Get current triggers blocklist
+client.triggers_blocklist
+
+# Update current triggers blocklist
+client.put_triggers_blocklist(body: { blocklist: ['in', 'it', 'page'] })
+----------------------------

data/lib/elastic/app-search/api/add_meta_engine_source.rb

@@ -21,9 +21,10 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Engine - Add a source engine to an existing meta engine
+        # Engines - Add a source engine
+        # Adds a source engine to a given meta engine
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
         # @option arguments [Array] :source_engines List of engine names (*Required*)
         # @option arguments [Hash] :headers optional HTTP headers to send with the request

data/lib/elastic/app-search/api/api_key.rb

@@ -21,7 +21,8 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Credentials - Get the details of an API key
+        # Credentials - Retrieve an API key
+        # Retrieves details of an API key
         #
         # @param arguments [Hash] endpoint arguments
         # @option arguments [String] :api_key_name Name of an API key (*Required*)

data/lib/elastic/app-search/api/api_logs.rb

@@ -21,27 +21,28 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Logs - The API Log displays API request and response data at the Engine level
+        # APILogs - Retrieve API logs
+        # The API Log displays API request and response data at the Engine level
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [String] :from_date Filter date from (*Required*)
-        # @option arguments [String] :to_date Filter date to (*Required*)
-        # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
-        # @option arguments [Integer] :page_size The number of results per page
-        # @option arguments [String] :query Use this to specify a particular endpoint, like analytics, search, curations and so on
-        # @option arguments [String] :http_status_filter Filter based on a particular status code: 400, 401, 403, 429, 200
-        # @option arguments [String] :http_method_filter Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
-        # @option arguments [String] :sort_direction Would you like to have your results ascending, oldest to newest, or descending, newest to oldest?
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Date] :from_date Filter date from (*Required*)
+        # @option arguments [Date] :to_date Filter date to (*Required*)
+        # @option arguments [Hash] :body
+        # @option body [String] :query You can search over the full_request_path of an API Log event. Use this to specify a particular endpoint, like analytics, search, curations and so on.
+        # @option body [String] :sort_direction Would you like to have your results ascending, oldest to newest, or descending, newest to oldest? Accepts asc or desc. Defaults to ascending.
+        # @option body [Integer] :page current for current page, total_pages for the net number of pages, total_results for the overall number of results, size for the amount of results per page.
+        # @option body :filters
+        # @option filters [String] :status Filter based on a particular status code: 400, 401, 403, 429, 200
+        # @option filters [String] :method Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/api-logs.html
         #
         def api_logs(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
           raise ArgumentError, "Required parameter 'from_date' missing" unless arguments[:from_date]
           raise ArgumentError, "Required parameter 'to_date' missing" unless arguments[:to_date]
-          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
 
           body = arguments.delete(:body) || {}
           headers = arguments.delete(:headers) || {}
@@ -49,7 +50,7 @@ module Elastic
           arguments['filters[date][to]'] = date_to_rfc3339(arguments.delete(:to_date))
 
           request(
-            :get,
+            :post,
             "api/as/v1/engines/#{engine_name}/logs/api/",
             arguments,
             body,

data/lib/elastic/app-search/api/count_analytics.rb

@@ -21,13 +21,14 @@ module Elastic
   module EnterpriseSearch
     module AppSearch
       module Actions
-        # Analytics - Returns the number of clicks and total number of queries over a period
+        # Analytics - Query for analytics counts data
+        # Returns the number of clicks and total number of queries over a period
         #
-        # @param engine_name [String]  (*Required*)
+        # @param engine_name [String] Name of the engine (*Required*)
         # @param arguments [Hash] endpoint arguments
-        # @option arguments [Array] :filters Analytics filters
-        # @option arguments [String] :interval You can define an interval along with your date range. Can be either hour or day
-        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :body
+        # @option body :filters Analytics filters
+        # @option body [String] :interval You can define an interval along with your date range. Can be either hour or day
         # @option arguments [Hash] :headers optional HTTP headers to send with the request
         #
         # @see https://www.elastic.co/guide/en/app-search/current/counts.html
@@ -39,7 +40,7 @@ module Elastic
           headers = arguments.delete(:headers) || {}
 
           request(
-            :get,
+            :post,
             "api/as/v1/engines/#{engine_name}/analytics/counts/",
             arguments,
             body,

data/lib/elastic/app-search/api/crawler_active_crawl_request.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Get active crawl request details
+        # Returns active crawl request details.
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-active
+        #
+        def crawler_active_crawl_request(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end

data/lib/elastic/app-search/api/crawler_crawl_request.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# 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.
+
+module Elastic
+  module EnterpriseSearch
+    module AppSearch
+      module Actions
+        # Crawler - Get crawl request details
+        # Returns crawl request details.
+        #
+        # @param engine_name [String] Name of the engine (*Required*)
+        # @param arguments [Hash] endpoint arguments
+        # @option arguments [String] :crawl_request_id Crawl Request ID (*Required*)
+        # @option arguments [Hash] :body The request body
+        # @option arguments [Hash] :headers optional HTTP headers to send with the request
+        #
+        # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-id
+        #
+        def crawler_crawl_request(engine_name, arguments = {})
+          raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
+          raise ArgumentError, "Required parameter 'crawl_request_id' missing" unless arguments[:crawl_request_id]
+
+          crawl_request_id = arguments[:crawl_request_id]
+          body = arguments.delete(:body) || {}
+          headers = arguments.delete(:headers) || {}
+
+          request(
+            :get,
+            "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
+            arguments,
+            body,
+            headers
+          )
+        end
+      end
+    end
+  end
+end