elastic-enterprise-search 7.14.0 → 7.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/functions/imports.sh +1 -0
  3. data/.ci/jobs/defaults.yml +4 -0
  4. data/.ci/jobs/{elastic+enterprise-search-ruby+master.yml → elastic+enterprise-search-ruby+main.yml} +4 -4
  5. data/.ci/run-repository.sh +2 -1
  6. data/.ci/test-matrix.yml +5 -3
  7. data/.github/workflows/testing.yml +1 -1
  8. data/CONTRIBUTING.md +1 -1
  9. data/README.md +1 -1
  10. data/Rakefile +19 -0
  11. data/docs/guide/app-search-api.asciidoc +129 -1
  12. data/docs/guide/overview.asciidoc +3 -3
  13. data/docs/guide/release_notes/715.asciidoc +36 -0
  14. data/docs/guide/release_notes/index.asciidoc +2 -0
  15. data/docs/guide/workplace-search-api.asciidoc +14 -0
  16. data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -2
  17. data/lib/elastic/app-search/api/api_key.rb +2 -1
  18. data/lib/elastic/app-search/api/api_logs.rb +14 -13
  19. data/lib/elastic/app-search/api/count_analytics.rb +7 -6
  20. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +51 -0
  21. data/lib/elastic/app-search/api/crawler_crawl_request.rb +54 -0
  22. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +51 -0
  23. data/lib/elastic/app-search/api/crawler_domain.rb +54 -0
  24. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +48 -0
  25. data/lib/elastic/app-search/api/crawler_metrics.rb +48 -0
  26. data/lib/elastic/app-search/api/crawler_overview.rb +51 -0
  27. data/lib/elastic/app-search/api/crawler_process_crawl.rb +54 -0
  28. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +54 -0
  29. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +52 -0
  30. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +52 -0
  31. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +52 -0
  32. data/lib/elastic/app-search/api/crawler_user_agent.rb +48 -0
  33. data/lib/elastic/app-search/api/create_api_key.rb +9 -1
  34. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +51 -0
  35. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +59 -0
  36. data/lib/elastic/app-search/api/create_crawler_domain.rb +55 -0
  37. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +56 -0
  38. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +53 -0
  39. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +56 -0
  40. data/lib/elastic/app-search/api/create_curation.rb +7 -6
  41. data/lib/elastic/app-search/api/create_engine.rb +9 -7
  42. data/lib/elastic/app-search/api/create_synonym_set.rb +7 -4
  43. data/lib/elastic/app-search/api/curation.rb +4 -3
  44. data/lib/elastic/app-search/api/delete_active_crawl_request.rb +51 -0
  45. data/lib/elastic/app-search/api/delete_api_key.rb +1 -0
  46. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +51 -0
  47. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +57 -0
  48. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +51 -0
  49. data/lib/elastic/app-search/api/delete_crawler_domain.rb +54 -0
  50. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +57 -0
  51. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +57 -0
  52. data/lib/elastic/app-search/api/delete_curation.rb +4 -3
  53. data/lib/elastic/app-search/api/delete_documents.rb +2 -1
  54. data/lib/elastic/app-search/api/delete_engine.rb +3 -2
  55. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -3
  56. data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -3
  57. data/lib/elastic/app-search/api/denied_urls.rb +54 -0
  58. data/lib/elastic/app-search/api/documents.rb +3 -2
  59. data/lib/elastic/app-search/api/engine.rb +3 -2
  60. data/lib/elastic/app-search/api/index_documents.rb +3 -2
  61. data/lib/elastic/app-search/api/list_api_keys.rb +2 -1
  62. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +52 -0
  63. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +51 -0
  64. data/lib/elastic/app-search/api/list_curations.rb +3 -2
  65. data/lib/elastic/app-search/api/list_documents.rb +3 -2
  66. data/lib/elastic/app-search/api/list_engines.rb +2 -1
  67. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -2
  68. data/lib/elastic/app-search/api/log_clickthrough.rb +8 -10
  69. data/lib/elastic/app-search/api/put_api_key.rb +9 -2
  70. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +62 -0
  71. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +53 -0
  72. data/lib/elastic/app-search/api/put_crawler_domain.rb +58 -0
  73. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +59 -0
  74. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +59 -0
  75. data/lib/elastic/app-search/api/put_curation.rb +9 -8
  76. data/lib/elastic/app-search/api/put_documents.rb +3 -3
  77. data/lib/elastic/app-search/api/put_schema.rb +4 -4
  78. data/lib/elastic/app-search/api/put_search_settings.rb +6 -2
  79. data/lib/elastic/app-search/api/put_synonym_set.rb +8 -5
  80. data/lib/elastic/app-search/api/query_suggestion.rb +7 -7
  81. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -2
  82. data/lib/elastic/app-search/api/schema.rb +3 -2
  83. data/lib/elastic/app-search/api/search.rb +14 -3
  84. data/lib/elastic/app-search/api/search_settings.rb +3 -2
  85. data/lib/elastic/app-search/api/synonym_set.rb +4 -3
  86. data/lib/elastic/app-search/api/top_clicks_analytics.rb +8 -8
  87. data/lib/elastic/app-search/api/top_queries_analytics.rb +7 -7
  88. data/lib/elastic/app-search/app_search.rb +0 -10
  89. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  90. data/lib/elastic/enterprise-search/api/put_read_only.rb +3 -2
  91. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  92. data/lib/elastic/enterprise-search/api/version.rb +1 -0
  93. data/lib/elastic/enterprise-search/request.rb +10 -1
  94. data/lib/elastic/enterprise-search/version.rb +1 -1
  95. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +49 -0
  96. data/lib/elastic/workplace-search/api/create_content_source.rb +1 -0
  97. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +1 -1
  98. data/lib/elastic/workplace-search/api/put_content_source.rb +1 -0
  99. data/lib/elastic/workplace-search/api/put_synonym_set.rb +1 -1
  100. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +47 -0
  101. data/lib/elastic/workplace-search/api/search.rb +3 -0
  102. data/lib/elastic/workplace-search/api/synonym_set.rb +1 -1
  103. data/{spec/app-search/api_logs_spec.rb → lib/elastic/workplace-search/api/triggers_blocklist.rb} +23 -14
  104. data/lib/elastic/workplace-search/workplace_search.rb +0 -15
  105. data/spec/integration/app-search/api_key_spec.rb +110 -0
  106. data/spec/integration/app-search/api_logs_spec.rb +59 -0
  107. data/spec/{app-search/api_spec_helper.rb → integration/app-search/app_search_helper.rb} +17 -8
  108. data/spec/integration/app-search/count_analytics_spec.rb +47 -0
  109. data/spec/integration/app-search/crawl_requests_spec.rb +86 -0
  110. data/spec/integration/app-search/crawler_crawl_rule_spec.rb +73 -0
  111. data/spec/integration/app-search/crawler_domain_spec.rb +82 -0
  112. data/spec/integration/app-search/crawler_entry_point_spec.rb +89 -0
  113. data/spec/integration/app-search/crawler_metrics_spec.rb +46 -0
  114. data/spec/integration/app-search/crawler_overview_spec.rb +45 -0
  115. data/spec/integration/app-search/crawler_process_crawl_denied_urls_spec.rb +50 -0
  116. data/spec/integration/app-search/crawler_process_crawl_spec.rb +66 -0
  117. data/spec/integration/app-search/crawler_scheduling_spec.rb +81 -0
  118. data/spec/integration/app-search/crawler_sitemap_spec.rb +72 -0
  119. data/spec/integration/app-search/crawler_urls_spec.rb +60 -0
  120. data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb} +6 -9
  121. data/spec/integration/app-search/curations_spec.rb +118 -0
  122. data/spec/integration/app-search/documents_spec.rb +123 -0
  123. data/spec/integration/app-search/engines_spec.rb +77 -0
  124. data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb} +14 -7
  125. data/spec/integration/app-search/meta_engines_spec.rb +75 -0
  126. data/spec/integration/app-search/query_suggestion_spec.rb +50 -0
  127. data/spec/{app-search/api_schema_spec.rb → integration/app-search/schema_spec.rb} +21 -16
  128. data/spec/integration/app-search/search_and_multiple_search_spec.rb +67 -0
  129. data/spec/integration/app-search/search_settings_spec.rb +87 -0
  130. data/spec/integration/app-search/synonyms_spec.rb +79 -0
  131. data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb} +20 -14
  132. data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb} +16 -8
  133. data/spec/integration/workplace-search/content_sources_spec.rb +106 -0
  134. data/spec/integration/workplace-search/documents_spec.rb +95 -0
  135. data/spec/integration/workplace-search/external_identities_spec.rb +97 -0
  136. data/spec/integration/{icon.png → workplace-search/icon.png} +0 -0
  137. data/spec/integration/workplace-search/permissions_spec.rb +77 -0
  138. data/spec/integration/workplace-search/synonym_sets_spec.rb +92 -0
  139. data/spec/integration/workplace-search/triggers_spec.rb +43 -0
  140. data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb} +12 -15
  141. data/spec/integration/workplace-search/workplace_search_helper.rb +39 -0
  142. metadata +79 -64
  143. data/spec/app-search/api_apikey_spec.rb +0 -92
  144. data/spec/app-search/api_curations_spec.rb +0 -97
  145. data/spec/app-search/api_documents_spec.rb +0 -102
  146. data/spec/app-search/api_engines_spec.rb +0 -67
  147. data/spec/app-search/api_meta_engines_spec.rb +0 -72
  148. data/spec/app-search/api_search_and_multi_search_spec.rb +0 -48
  149. data/spec/app-search/api_search_settings_spec.rb +0 -76
  150. data/spec/app-search/api_synonyms_spec.rb +0 -79
  151. data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +0 -109
  152. data/spec/fixtures/vcr/app_search/api_documents.yml +0 -56
  153. data/spec/fixtures/vcr/app_search/api_index_documents.yml +0 -57
  154. data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +0 -54
  155. data/spec/fixtures/vcr/app_search/api_logs.yml +0 -70
  156. data/spec/fixtures/vcr/app_search/api_put_schema.yml +0 -109
  157. data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +0 -56
  158. data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +0 -59
  159. data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +0 -56
  160. data/spec/fixtures/vcr/app_search/api_schema.yml +0 -56
  161. data/spec/fixtures/vcr/app_search/api_search_settings.yml +0 -56
  162. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +0 -55
  163. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +0 -55
  164. data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +0 -55
  165. data/spec/fixtures/vcr/app_search/count_analytics.yml +0 -55
  166. data/spec/fixtures/vcr/app_search/create_and_update_document.yml +0 -107
  167. data/spec/fixtures/vcr/app_search/create_api_key.yml +0 -52
  168. data/spec/fixtures/vcr/app_search/create_curation.yml +0 -113
  169. data/spec/fixtures/vcr/app_search/create_engine.yml +0 -55
  170. data/spec/fixtures/vcr/app_search/create_meta_engine.yml +0 -56
  171. data/spec/fixtures/vcr/app_search/create_synonym_set.yml +0 -56
  172. data/spec/fixtures/vcr/app_search/delete_api_key.yml +0 -52
  173. data/spec/fixtures/vcr/app_search/delete_curation.yml +0 -56
  174. data/spec/fixtures/vcr/app_search/delete_engine.yml +0 -55
  175. data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +0 -56
  176. data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +0 -56
  177. data/spec/fixtures/vcr/app_search/get_api_key.yml +0 -52
  178. data/spec/fixtures/vcr/app_search/get_curation.yml +0 -56
  179. data/spec/fixtures/vcr/app_search/get_engine.yml +0 -55
  180. data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +0 -107
  181. data/spec/fixtures/vcr/app_search/list_api_keys.yml +0 -52
  182. data/spec/fixtures/vcr/app_search/list_curations.yml +0 -56
  183. data/spec/fixtures/vcr/app_search/list_documents.yml +0 -57
  184. data/spec/fixtures/vcr/app_search/list_engines.yml +0 -55
  185. data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +0 -56
  186. data/spec/fixtures/vcr/app_search/multi_query_search.yml +0 -63
  187. data/spec/fixtures/vcr/app_search/put_api_key.yml +0 -52
  188. data/spec/fixtures/vcr/app_search/put_curation.yml +0 -113
  189. data/spec/fixtures/vcr/app_search/put_synonym_set.yml +0 -56
  190. data/spec/fixtures/vcr/app_search/search.yml +0 -57
  191. data/spec/fixtures/vcr/app_search/single_query_search.yml +0 -60
  192. data/spec/fixtures/vcr/app_search/synonym_set.yml +0 -56
  193. data/spec/integration/workplace_search_spec.rb +0 -375
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1eef7550b4a936e514eb9b0eb52272a2b445b3e54c301c7cec29039c789561ee
4
- data.tar.gz: 47ab2fcbb9b00a3cbb219e713ee9308642345b72dcc6af5b9f0f1f334edd7c09
3
+ metadata.gz: 6ebc1dd416a61d523f8de08fe29e3308539cce59a55a9edcbffc7997c85910d5
4
+ data.tar.gz: 2dd11f3198ee70cea2d7f9d76f4d411ee47160b5e4d0ba1a32080cc830301b5d
5
5
  SHA512:
6
- metadata.gz: 38a4519bfa5d4b3ea04507468b0c5ddb7122d8c5c928943b45d3d1ce120d3a1652ac7c2aff217082aaca4cdc3124b732e4f31c265bf5c6f0cdc0173672e020f0
7
- data.tar.gz: 7cd26fe0a7fc874ccbcfb16ef443d5c9ddd69b0a882690dcbfc0b90d698a10bd89d942530ba93aae78531cddc6960721edd8d2a410728be87aacd018e1aeed31
6
+ metadata.gz: d9d5499b123c3d026d2c2dbde6a0a9952321c3b2befd12cd42199d3d032d26f65a02e371bc32ceb9a9f3bcb3c085e83aed2ad5b292b43aeed6bdf5db37878744
7
+ data.tar.gz: d212455f5c39d99eea502669241b4dbd848615e0de15109b764465d124b003696d0dd0737a276f294ac0ee9a17b56027dd711c6e1f1cd615aec09005bf30dadd
@@ -19,6 +19,7 @@ if [[ -z $es_node_name ]]; then
19
19
  # only set these once
20
20
  set -euo pipefail
21
21
  export TEST_SUITE=${TEST_SUITE-free}
22
+ export SERVICE=${SERVICE-}
22
23
  export RUNSCRIPTS=${RUNSCRIPTS-}
23
24
  export DETACH=${DETACH-false}
24
25
  export CLEANUP=${CLEANUP-false}
@@ -46,6 +46,10 @@
46
46
  type: yaml
47
47
  filename: .ci/test-matrix.yml
48
48
  name: RUBY_VERSION
49
+ - axis:
50
+ type: yaml
51
+ filename: .ci/test-matrix.yml
52
+ name: SERVICE
49
53
  yaml-strategy:
50
54
  exclude-key: exclude
51
55
  filename: .ci/test-matrix.yml
@@ -1,12 +1,12 @@
1
1
  ---
2
2
  - job:
3
- name: elastic+enterprise-search-ruby+master
4
- display-name: 'elastic / enterprise-search-ruby # master'
5
- description: Testing the enterprise-search-ruby master branch.
3
+ name: elastic+enterprise-search-ruby+main
4
+ display-name: 'elastic / enterprise-search-ruby # main'
5
+ description: Testing the enterprise-search-ruby main branch.
6
6
  junit_results: "*-junit.xml"
7
7
  parameters:
8
8
  - string:
9
9
  name: branch_specifier
10
- default: refs/heads/master
10
+ default: refs/heads/main
11
11
  description: the Git branch specifier to build (<branchName>, <tagName>,
12
12
  <commitId>, etc.)
@@ -17,6 +17,7 @@ echo -e "\033[34;1mINFO:\033[0m TEST_SUITE: ${TEST_SUITE}\033[0m"
17
17
  echo -e "\033[34;1mINFO:\033[0m RUBY_VERSION: ${RUBY_VERSION}\033[0m"
18
18
  echo -e "\033[34;1mINFO:\033[0m RUNSCRIPTS: ${RUNSCRIPTS}\033[0m"
19
19
  echo -e "\033[34;1mINFO:\033[0m URL: ${elasticsearch_url}\033[0m"
20
+ echo -e "\033[34;1mINFO:\033[0m SERVICE: ${SERVICE}\033[0m"
20
21
 
21
22
  echo -e "\033[34;1mINFO:\033[0m pinging Elasticsearch ..\033[0m"
22
23
  curl --insecure --fail $external_elasticsearch_url/_cluster/health?pretty
@@ -46,4 +47,4 @@ docker run \
46
47
  --rm \
47
48
  --volume `pwd`:/code/enterprise-search-ruby \
48
49
  elastic/enterprise-search-ruby \
49
- rake spec:integration
50
+ rake spec:integration:${SERVICE}
data/.ci/test-matrix.yml CHANGED
@@ -6,9 +6,11 @@ RUBY_VERSION:
6
6
  - 2.5
7
7
 
8
8
  STACK_VERSION:
9
- - 7.14-SNAPSHOT
9
+ - 7.15-SNAPSHOT
10
10
 
11
- TEST_SUITE:
12
- - platinum
11
+ SERVICE:
12
+ - appsearch
13
+ - enterprisesearch
14
+ - workplacesearch
13
15
 
14
16
  exclude: ~
@@ -1,4 +1,4 @@
1
- name: 7.14
1
+ name: 7.15
2
2
  on: [push, pull_request]
3
3
 
4
4
  jobs:
data/CONTRIBUTING.md CHANGED
@@ -22,7 +22,7 @@
22
22
 
23
23
  3. Rebase your changes. Update your local repository with the most recent code
24
24
  from the main `enterprise-search-ruby` repository and rebase your branch
25
- on top of the latest `master` branch. All of your changes will be squashed
25
+ on top of the latest `main` branch. All of your changes will be squashed
26
26
  into a single commit so don't worry about pushing multiple times.
27
27
 
28
28
  4. Submit a pull request. Push your local changes to your forked repository
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Elastic Enterprise Search Client
2
2
 
3
- ![build](https://github.com/elastic/enterprise-search-ruby/workflows/master/badge.svg)
3
+ ![build](https://github.com/elastic/enterprise-search-ruby/workflows/main/badge.svg)
4
4
  ![rubocop](https://github.com/elastic/enterprise-search-ruby/workflows/rubocop/badge.svg)
5
5
  [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
6
6
 
data/Rakefile CHANGED
@@ -31,6 +31,7 @@ task :stack, [:version] do |_, params|
31
31
  sh "STACK_VERSION=#{params[:version]} ./.ci/run-local.sh"
32
32
  end
33
33
 
34
+ # rubocop:disable Metrics/BlockLength
34
35
  namespace :spec do
35
36
  desc 'Run client tests'
36
37
  task :client do
@@ -46,4 +47,22 @@ namespace :spec do
46
47
  task :all do
47
48
  sh 'rspec spec'
48
49
  end
50
+
51
+ namespace :integration do
52
+ desc 'Run App Search integration tests'
53
+ task :appsearch do
54
+ sh 'rspec spec/integration/app-search'
55
+ end
56
+
57
+ desc 'Run Enterprise Search integration tests'
58
+ task :enterprisesearch do
59
+ sh 'rspec spec/integration/enterprise_search_api_spec.rb'
60
+ end
61
+
62
+ desc 'Run Workplace Search integration tests'
63
+ task :workplacesearch do
64
+ sh 'rspec spec/integration/workplace-search'
65
+ end
66
+ end
49
67
  end
68
+ # rubocop:enable Metrics/BlockLength
@@ -1,6 +1,8 @@
1
1
  [[app-search-api]]
2
2
  == App Search API
3
3
 
4
+ 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].
5
+
4
6
  === Engines
5
7
 
6
8
  [source,rb]
@@ -174,6 +176,132 @@ client.put_api_key(api_key_name: name, body: body)
174
176
  client.delete_api_key(api_key_name: name)
175
177
  ----------------------------
176
178
 
179
+ === Web Crawler
180
+
181
+ [CAUTION]
182
+ ====
183
+ The Elastic Enterprise Search web crawler API is a *beta* feature.
184
+ Beta features are subject to change and are not covered by the support SLA of general release (GA) features.
185
+ Elastic plans to promote this feature to GA in a future release.
186
+ ====
187
+
188
+ See https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html[Web Crawler API reference] for more information.
189
+
190
+ [source,rb]
191
+ ----------------------------
192
+ # Create a crawler domain
193
+ body = { name: 'https://www.elastic.co' }
194
+ client.create_crawler_domain(engine_name, body: body)
195
+
196
+ # Get crawler domain information
197
+ client.crawler_domain(engine_name, domain_id: domain_id)
198
+
199
+ # Update a crawler domain
200
+ body = { name: 'https://www.wikipedia.org' }
201
+ client.put_crawler_domain(engine_name, domain_id: domain_id, domain: body)
202
+
203
+ # Delete a crawler domain
204
+ client.delete_crawler_domain(engine_name, domain_id: domain_id)
205
+
206
+ # Create a crawler crawl request
207
+ client.create_crawler_crawl_request(engine_name)
208
+
209
+ # Retrieve a crawl request
210
+ client.crawler_crawl_request(engine_name, crawl_request_id: request_id)
211
+
212
+ # Retrieve active crawl request details
213
+ client.crawler_active_crawl_request(engine_name)
214
+
215
+ # List crawl requests
216
+ client.list_crawler_crawl_requests(engine_name)
217
+
218
+ # Delete an active crawl request
219
+ client.delete_active_crawl_request(engine_name)
220
+
221
+ # Set a crawler crawl schedule
222
+ body = { frequency: 1, unit: 'day' }
223
+ client.put_crawler_crawl_schedule(engine_name, body: body)
224
+
225
+ # Retrieve crawler crawl schedule
226
+ client.crawler_crawl_schedule(engine_name)
227
+
228
+ # Delete a crawler crawl schedule
229
+ client.delete_crawler_crawl_schedule(engine_name)
230
+
231
+ # Create a crawler entry point
232
+ client.create_crawler_entry_point(engine_name, domain_id: domain_id, body: { value: '/elastic-stack' })
233
+
234
+ # Update a crawler entry point
235
+ client.put_crawler_entry_point(
236
+ engine_name,
237
+ domain_id: domain_id,
238
+ entry_point_id: entry_point_id,
239
+ body: { value: '/enterprise-search' }
240
+ )
241
+
242
+ # Validate a URL
243
+ client.crawler_url_validation_result(engine_name, url: name)
244
+
245
+ # Extract ccontent from a URL
246
+ client.crawler_url_extraction_result(engine_name, url: name)
247
+
248
+ # Retrieve tracing history for a crawler URL
249
+ client.crawler_url_tracing_result(engine_name, url: name)
250
+
251
+ # Delete a crawler entry point
252
+ client.delete_crawler_entry_point(
253
+ engine_name,
254
+ domain_id: domain_id,
255
+ entry_point_id: entry_point_id
256
+ )
257
+
258
+ # Retrieve crawler metrics
259
+ client.crawler_metrics
260
+
261
+ # Retrieve crawler configuration overview
262
+ client.crawler_overview(engine_name)
263
+
264
+ # Create a crawler sitemap
265
+ body = { url: 'https://www.elastic.co/sitemap.xml' }
266
+ client.create_crawler_sitemap(engine_name, domain_id: domain_id, body: body)
267
+
268
+ # Update a crawler sitemap
269
+ body = { url: 'https://www.elastic.co/sitemap2.xml' }
270
+ client.put_crawler_sitemap(engine_name, domain_id: domain_id, sitemap_id: sitemap_id, body: body)
271
+
272
+ # Delete a crawler sitemap
273
+ client.delete_crawler_sitemap(engine_name, domain_id: domain_id, sitemap_id: sitemap_id)
274
+
275
+ # Create a crawler crawl rule
276
+ body = { order: 1, policy: 'allow', rule: 'contains', pattern: '/stack' }
277
+ client.create_crawler_crawl_rule(engine_name, domain_id: domain_id, body: body)
278
+
279
+ # Update a crawler crawl rule
280
+ body = { order: 2, policy: 'allow', rule: 'begins', pattern: '/stack' }
281
+ client.put_crawler_crawl_rule(engine_name, domain_id: domain_id, crawl_rule_id: rule_id, body: body)
282
+
283
+ # Delete a crawler crawl rule
284
+ client.delete_crawler_crawl_rule(engine_name, domain_id: domain_id, crawl_rule_id: rule_id)
285
+
286
+ # Create a process crawl
287
+ client.create_crawler_process_crawl(engine_name, body: { dry_run: true })
288
+
289
+ # Retrieve a process crawl
290
+ client.crawler_process_crawl(engine_name, process_crawl_id: id)
291
+
292
+ # Retrieve denied URLs cor a process crawl
293
+ client.denied_urls(engine_name, process_crawl_id: id)
294
+
295
+ # List process crawls
296
+ client.list_crawler_process_crawls(engine_name)
297
+
298
+ # View denied urls for Process Crawl
299
+ client.crawler_process_crawl_denied_urls(engine_name, process_crawl_id: id)
300
+
301
+ # Cancel an active crawl request, stopping a running crawl if needed.
302
+ client.delete_crawler_active_crawl_request(engine_name)
303
+ ----------------------------
304
+
177
305
  === Other API Endpoints
178
306
 
179
307
  [source,rb]
@@ -207,7 +335,7 @@ client.put_search_settings(engine_name, body: body)
207
335
  client.reset_search_settings(engine_name)
208
336
 
209
337
  # Click - Send data about clicked results
210
- client.log_clickthrough(engine_name, query_text: 'query', document_id: 'doc-id')
338
+ client.log_clickthrough(engine_name, body: { query: 'query', document_id: 'doc-id' })
211
339
 
212
340
  # Query Suggestion - Provide relevant query suggestions for incomplete queries
213
341
  client.query_suggestion(engine_name, query: 'incomplete_query')
@@ -6,7 +6,7 @@ This is the official Ruby client for Elastic Enterprise Search.
6
6
  [discrete]
7
7
  === Compatibility
8
8
 
9
- Current development happens in the master branch.
9
+ Current development happens in the main branch.
10
10
 
11
11
  The library is compatible with all Elastic Enterprise Search versions since `7.x` but you **have to use a matching major version**:
12
12
 
@@ -14,11 +14,11 @@ For **Elastic Enterprise Search 7.0** and later, use the major version 7 (`7.x.y
14
14
 
15
15
  [discrete]
16
16
  === HTTP Library
17
- 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].
17
+ 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].
18
18
 
19
19
  All requests, if successful, will return an `Elasticsearch::Transport::Transport::Response` instance. You can access the response `body`, `headers` and `status`.
20
20
 
21
- `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].
21
+ `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].
22
22
 
23
23
  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].
24
24
 
@@ -0,0 +1,36 @@
1
+ [[release_notes_715]]
2
+ === 7.15.0 Release notes
3
+
4
+ [discrete]
5
+ ==== General
6
+
7
+ - Tested with Elastic Enterprise Search API version 7.15.0.
8
+ - Better source code documentation in general for API endpoints.
9
+
10
+ [discrete]
11
+ ==== App Search
12
+
13
+ - 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.
14
+
15
+ - 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.
16
+
17
+ [discrete]
18
+ ===== Web Crawler API
19
+
20
+ [CAUTION]
21
+ ====
22
+ The Elastic Enterprise Search web crawler API is a *beta* feature.
23
+ Beta features are subject to change and are not covered by the support SLA of general release (GA) features.
24
+ Elastic plans to promote this feature to GA in a future release.
25
+ ====
26
+
27
+ New Web Crawler API endpoints:
28
+
29
+ `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`.
30
+
31
+ 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.
32
+
33
+ [discrete]
34
+ ==== Workplace Search
35
+
36
+ - 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.
@@ -5,12 +5,14 @@
5
5
  [discrete]
6
6
  === 7.x
7
7
 
8
+ * <<release_notes_715, 7.15.0 Release Notes>>
8
9
  * <<release_notes_714, 7.14.0 Release Notes>>
9
10
  * <<release_notes_713, 7.13.0 Release Notes>>
10
11
  * <<release_notes_712, 7.12.0 Release Notes>>
11
12
  * <<release_notes_711, 7.11.0 Release Notes>>
12
13
  * <<release_notes_710, 7.10.0.beta.1 Release Notes>>
13
14
 
15
+ include::715.asciidoc[]
14
16
  include::714.asciidoc[]
15
17
  include::713.asciidoc[]
16
18
  include::712.asciidoc[]
@@ -37,6 +37,9 @@ require 'base64'
37
37
  path = File.expand_path("#{File.dirname(__FILE__)}/icon.png")
38
38
  icon = Base64.strict_encode64(File.read(path))
39
39
  response = client.put_content_source_icons(content_source_id, main_icon: icon, alt_icon: icon)
40
+
41
+ # Retrieves a content source's automatic query refinement details
42
+ client.auto_query_refinement_details(content_source_id)
40
43
  ----------------------------
41
44
 
42
45
  === Documents
@@ -218,3 +221,14 @@ client.current_user
218
221
  # Get the current user and return the access token
219
222
  client.current_user(get_token: true)
220
223
  ----------------------------
224
+
225
+ === Triggers Blocklist
226
+
227
+ [source,rb]
228
+ ----------------------------
229
+ # Get current triggers blocklist
230
+ client.triggers_blocklist
231
+
232
+ # Update current triggers blocklist
233
+ client.put_triggers_blocklist(body: { blocklist: ['in', 'it', 'page'] })
234
+ ----------------------------
@@ -21,9 +21,10 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Engine - Add a source engine to an existing meta engine
24
+ # Engines - Add a source engine
25
+ # Adds a source engine to a given meta engine
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
29
  # @option arguments [Array] :source_engines List of engine names (*Required*)
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
@@ -21,7 +21,8 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Credentials - Get the details of an API key
24
+ # Credentials - Retrieve an API key
25
+ # Retrieves details of an API key
25
26
  #
26
27
  # @param arguments [Hash] endpoint arguments
27
28
  # @option arguments [String] :api_key_name Name of an API key (*Required*)
@@ -21,27 +21,28 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Logs - The API Log displays API request and response data at the Engine level
24
+ # APILogs - Retrieve API logs
25
+ # The API Log displays API request and response data at the Engine level
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :from_date Filter date from (*Required*)
29
- # @option arguments [String] :to_date Filter date to (*Required*)
30
- # @option arguments [Integer] :current_page The page to fetch. Defaults to 1
31
- # @option arguments [Integer] :page_size The number of results per page
32
- # @option arguments [String] :query Use this to specify a particular endpoint, like analytics, search, curations and so on
33
- # @option arguments [String] :http_status_filter Filter based on a particular status code: 400, 401, 403, 429, 200
34
- # @option arguments [String] :http_method_filter Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
35
- # @option arguments [String] :sort_direction Would you like to have your results ascending, oldest to newest, or descending, newest to oldest?
36
- # @option arguments [Hash] :body The request body
29
+ # @option arguments [Date] :from_date Filter date from (*Required*)
30
+ # @option arguments [Date] :to_date Filter date to (*Required*)
31
+ # @option arguments [Hash] :body
32
+ # @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.
33
+ # @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.
34
+ # @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.
35
+ # @option body :filters
36
+ # @option filters [String] :status Filter based on a particular status code: 400, 401, 403, 429, 200
37
+ # @option filters [String] :method Filter based on a particular HTTP method: GET, POST, PUT, PATCH, DELETE
37
38
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
38
39
  #
39
40
  # @see https://www.elastic.co/guide/en/app-search/current/api-logs.html
40
41
  #
41
42
  def api_logs(engine_name, arguments = {})
43
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
42
44
  raise ArgumentError, "Required parameter 'from_date' missing" unless arguments[:from_date]
43
45
  raise ArgumentError, "Required parameter 'to_date' missing" unless arguments[:to_date]
44
- raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
45
46
 
46
47
  body = arguments.delete(:body) || {}
47
48
  headers = arguments.delete(:headers) || {}
@@ -49,7 +50,7 @@ module Elastic
49
50
  arguments['filters[date][to]'] = date_to_rfc3339(arguments.delete(:to_date))
50
51
 
51
52
  request(
52
- :get,
53
+ :post,
53
54
  "api/as/v1/engines/#{engine_name}/logs/api/",
54
55
  arguments,
55
56
  body,
@@ -21,13 +21,14 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Analytics - Returns the number of clicks and total number of queries over a period
24
+ # Analytics - Query for analytics counts data
25
+ # Returns the number of clicks and total number of queries over a period
25
26
  #
26
- # @param engine_name [String] (*Required*)
27
+ # @param engine_name [String] Name of the engine (*Required*)
27
28
  # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Array] :filters Analytics filters
29
- # @option arguments [String] :interval You can define an interval along with your date range. Can be either hour or day
30
- # @option arguments [Hash] :body The request body
29
+ # @option arguments [Hash] :body
30
+ # @option body :filters Analytics filters
31
+ # @option body [String] :interval You can define an interval along with your date range. Can be either hour or day
31
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
33
  #
33
34
  # @see https://www.elastic.co/guide/en/app-search/current/counts.html
@@ -39,7 +40,7 @@ module Elastic
39
40
  headers = arguments.delete(:headers) || {}
40
41
 
41
42
  request(
42
- :get,
43
+ :post,
43
44
  "api/as/v1/engines/#{engine_name}/analytics/counts/",
44
45
  arguments,
45
46
  body,
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to Elasticsearch B.V. under one or more contributor
4
+ # license agreements. See the NOTICE file distributed with
5
+ # this work for additional information regarding copyright
6
+ # ownership. Elasticsearch B.V. licenses this file to you under
7
+ # the Apache License, Version 2.0 (the "License"); you may
8
+ # not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ module AppSearch
23
+ module Actions
24
+ # Crawler - Get active crawl request details
25
+ # Returns active crawl request details.
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [Hash] :body The request body
30
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
+ #
32
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-active
33
+ #
34
+ def crawler_active_crawl_request(engine_name, arguments = {})
35
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
+
37
+ body = arguments.delete(:body) || {}
38
+ headers = arguments.delete(:headers) || {}
39
+
40
+ request(
41
+ :get,
42
+ "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/",
43
+ arguments,
44
+ body,
45
+ headers
46
+ )
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to Elasticsearch B.V. under one or more contributor
4
+ # license agreements. See the NOTICE file distributed with
5
+ # this work for additional information regarding copyright
6
+ # ownership. Elasticsearch B.V. licenses this file to you under
7
+ # the Apache License, Version 2.0 (the "License"); you may
8
+ # not use this file except in compliance with the License.
9
+ # You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Elastic
21
+ module EnterpriseSearch
22
+ module AppSearch
23
+ module Actions
24
+ # Crawler - Get crawl request details
25
+ # Returns crawl request details.
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [String] :crawl_request_id Crawl Request ID (*Required*)
30
+ # @option arguments [Hash] :body The request body
31
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
+ #
33
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-id
34
+ #
35
+ def crawler_crawl_request(engine_name, arguments = {})
36
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
+ raise ArgumentError, "Required parameter 'crawl_request_id' missing" unless arguments[:crawl_request_id]
38
+
39
+ crawl_request_id = arguments[:crawl_request_id]
40
+ body = arguments.delete(:body) || {}
41
+ headers = arguments.delete(:headers) || {}
42
+
43
+ request(
44
+ :get,
45
+ "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
46
+ arguments,
47
+ body,
48
+ headers
49
+ )
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end