elastic-enterprise-search 7.17.0 → 8.0.0.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (161) hide show
  1. checksums.yaml +4 -4
  2. data/.ci/jobs/elastic+enterprise-search-ruby+7.13.yml +12 -0
  3. data/.ci/jobs/elastic+enterprise-search-ruby+7.14.yml +12 -0
  4. data/.ci/jobs/elastic+enterprise-search-ruby+7.15.yml +12 -0
  5. data/.ci/jobs/elastic+enterprise-search-ruby+7.16.yml +12 -0
  6. data/.ci/test-matrix.yml +1 -2
  7. data/.github/workflows/testing.yml +3 -3
  8. data/.rubocop.yml +1 -1
  9. data/CHANGELOG +1 -0
  10. data/CODE_OF_CONDUCT +1 -0
  11. data/CONTRIBUTING.md +37 -0
  12. data/NOTICE +2 -0
  13. data/README.md +25 -29
  14. data/docs/guide/app-search-api.asciidoc +15 -9
  15. data/docs/guide/overview.asciidoc +11 -3
  16. data/docs/guide/release_notes/712.asciidoc +10 -0
  17. data/docs/guide/release_notes/714.asciidoc +0 -12
  18. data/docs/guide/release_notes/715.asciidoc +0 -12
  19. data/docs/guide/release_notes/80.asciidoc +14 -0
  20. data/docs/guide/release_notes/index.asciidoc +7 -0
  21. data/docs/guide/workplace-search-api.asciidoc +0 -3
  22. data/elastic-enterprise-search.gemspec +3 -3
  23. data/lib/elastic/api/response.rb +52 -0
  24. data/lib/elastic/{workplace-search/api/user_permissions.rb → app-search/api/adaptive_relevance_settings.rb} +10 -15
  25. data/lib/elastic/{workplace-search/api/add_user_permissions.rb → app-search/api/adaptive_relevance_suggestions.rb} +20 -14
  26. data/lib/elastic/app-search/api/add_meta_engine_source.rb +4 -5
  27. data/lib/elastic/app-search/api/api_key.rb +4 -6
  28. data/lib/elastic/app-search/api/api_logs.rb +8 -15
  29. data/lib/elastic/app-search/api/count_analytics.rb +5 -5
  30. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +4 -7
  31. data/lib/elastic/app-search/api/crawler_crawl_request.rb +6 -8
  32. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +4 -7
  33. data/lib/elastic/app-search/api/crawler_domain.rb +6 -8
  34. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +6 -5
  35. data/lib/elastic/app-search/api/crawler_metrics.rb +3 -6
  36. data/lib/elastic/app-search/api/crawler_overview.rb +4 -7
  37. data/lib/elastic/app-search/api/crawler_process_crawl.rb +6 -8
  38. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +6 -8
  39. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +6 -6
  40. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +7 -7
  41. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +7 -7
  42. data/lib/elastic/app-search/api/crawler_user_agent.rb +3 -6
  43. data/lib/elastic/app-search/api/create_api_key.rb +10 -10
  44. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +9 -5
  45. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +13 -11
  46. data/lib/elastic/app-search/api/create_crawler_domain.rb +8 -8
  47. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +10 -8
  48. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +6 -6
  49. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +10 -8
  50. data/lib/elastic/app-search/api/create_curation.rb +10 -8
  51. data/lib/elastic/app-search/api/create_engine.rb +8 -7
  52. data/lib/elastic/app-search/api/create_synonym_set.rb +6 -6
  53. data/lib/elastic/app-search/api/curation.rb +5 -7
  54. data/lib/elastic/app-search/api/delete_api_key.rb +4 -6
  55. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +4 -7
  56. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +7 -9
  57. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +4 -7
  58. data/lib/elastic/app-search/api/delete_crawler_domain.rb +6 -8
  59. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +7 -9
  60. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +7 -9
  61. data/lib/elastic/app-search/api/delete_curation.rb +5 -7
  62. data/lib/elastic/app-search/api/delete_documents.rb +4 -5
  63. data/lib/elastic/app-search/api/delete_engine.rb +3 -6
  64. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +4 -4
  65. data/lib/elastic/app-search/api/delete_synonym_set.rb +5 -7
  66. data/lib/elastic/app-search/api/documents.rb +5 -5
  67. data/lib/elastic/app-search/api/engine.rb +3 -6
  68. data/lib/elastic/app-search/api/index_documents.rb +4 -5
  69. data/lib/elastic/{workplace-search/api/remove_user_permissions.rb → app-search/api/list_adaptive_relevance_suggestions.rb} +13 -14
  70. data/lib/elastic/app-search/api/list_api_keys.rb +2 -5
  71. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +6 -8
  72. data/lib/elastic/{workplace-search/api/list_permissions.rb → app-search/api/list_crawler_domains.rb} +12 -13
  73. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +6 -7
  74. data/lib/elastic/app-search/api/list_curations.rb +3 -6
  75. data/lib/elastic/app-search/api/list_documents.rb +3 -6
  76. data/lib/elastic/app-search/api/list_engines.rb +2 -5
  77. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -6
  78. data/lib/elastic/app-search/api/log_clickthrough.rb +9 -8
  79. data/lib/elastic/{workplace-search/api/put_user_permissions.rb → app-search/api/put_adaptive_relevance_settings.rb} +13 -14
  80. data/lib/elastic/app-search/api/put_adaptive_relevance_suggestions.rb +51 -0
  81. data/lib/elastic/app-search/api/put_api_key.rb +11 -10
  82. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +14 -12
  83. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +8 -7
  84. data/lib/elastic/app-search/api/put_crawler_domain.rb +9 -9
  85. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +11 -9
  86. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +11 -9
  87. data/lib/elastic/app-search/api/put_curation.rb +11 -9
  88. data/lib/elastic/app-search/api/put_documents.rb +4 -4
  89. data/lib/elastic/app-search/api/put_schema.rb +4 -4
  90. data/lib/elastic/app-search/api/put_search_settings.rb +6 -6
  91. data/lib/elastic/app-search/api/put_synonym_set.rb +8 -8
  92. data/lib/elastic/app-search/api/query_suggestion.rb +5 -5
  93. data/lib/elastic/app-search/api/refresh_adaptive_relevance_update_process.rb +56 -0
  94. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -6
  95. data/lib/elastic/app-search/api/schema.rb +3 -6
  96. data/lib/elastic/app-search/api/search.rb +6 -5
  97. data/lib/elastic/app-search/api/search_settings.rb +3 -6
  98. data/lib/elastic/app-search/api/synonym_set.rb +5 -7
  99. data/lib/elastic/app-search/api/top_clicks_analytics.rb +5 -5
  100. data/lib/elastic/app-search/api/top_queries_analytics.rb +4 -4
  101. data/lib/elastic/enterprise-search/api/health.rb +2 -3
  102. data/lib/elastic/enterprise-search/api/put_read_only.rb +6 -4
  103. data/lib/elastic/enterprise-search/api/read_only.rb +2 -3
  104. data/lib/elastic/enterprise-search/api/stats.rb +2 -3
  105. data/lib/elastic/enterprise-search/api/version.rb +2 -3
  106. data/lib/elastic/enterprise-search/client.rb +8 -13
  107. data/lib/elastic/enterprise-search/request.rb +5 -3
  108. data/lib/elastic/enterprise-search/version.rb +1 -1
  109. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +3 -4
  110. data/lib/elastic/workplace-search/api/command_sync_jobs.rb +4 -5
  111. data/lib/elastic/workplace-search/api/content_source.rb +3 -4
  112. data/lib/elastic/workplace-search/api/create_analytics_event.rb +16 -12
  113. data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +4 -3
  114. data/lib/elastic/workplace-search/api/create_content_source.rb +6 -5
  115. data/lib/elastic/workplace-search/api/create_external_identity.rb +11 -6
  116. data/lib/elastic/workplace-search/api/current_user.rb +3 -5
  117. data/lib/elastic/workplace-search/api/delete_content_source.rb +3 -4
  118. data/lib/elastic/workplace-search/api/delete_documents.rb +4 -4
  119. data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +4 -3
  120. data/lib/elastic/workplace-search/api/delete_external_identity.rb +7 -9
  121. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +3 -5
  122. data/lib/elastic/workplace-search/api/document.rb +4 -6
  123. data/lib/elastic/workplace-search/api/external_identity.rb +7 -9
  124. data/lib/elastic/workplace-search/api/index_documents.rb +3 -4
  125. data/lib/elastic/workplace-search/api/list_content_sources.rb +2 -3
  126. data/lib/elastic/workplace-search/api/list_documents.rb +4 -5
  127. data/lib/elastic/workplace-search/api/list_external_identities.rb +3 -4
  128. data/lib/elastic/workplace-search/api/list_synonym_sets.rb +1 -2
  129. data/lib/elastic/workplace-search/api/put_content_source.rb +6 -6
  130. data/lib/elastic/workplace-search/api/put_content_source_icons.rb +6 -6
  131. data/lib/elastic/workplace-search/api/put_external_identity.rb +11 -10
  132. data/lib/elastic/workplace-search/api/put_synonym_set.rb +4 -4
  133. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +3 -5
  134. data/lib/elastic/workplace-search/api/search.rb +13 -13
  135. data/lib/elastic/workplace-search/api/synonym_set.rb +3 -5
  136. data/lib/elastic/workplace-search/api/triggers_blocklist.rb +3 -3
  137. data/spec/app-search/client_spec.rb +29 -0
  138. data/spec/enterprise-search/client_spec.rb +29 -0
  139. data/spec/enterprise-search/request_spec.rb +1 -1
  140. data/spec/integration/app-search/adaptive_relevance_settings_spec.rb +60 -0
  141. data/spec/integration/app-search/adaptive_relevance_suggestions_spec.rb +54 -0
  142. data/spec/integration/app-search/api_logs_spec.rb +11 -3
  143. data/spec/integration/app-search/app_search_helper.rb +2 -2
  144. data/spec/integration/app-search/count_analytics_spec.rb +3 -2
  145. data/spec/integration/app-search/crawler_domain_spec.rb +16 -0
  146. data/spec/integration/app-search/curations_spec.rb +15 -9
  147. data/spec/integration/app-search/engines_spec.rb +24 -26
  148. data/spec/integration/app-search/log_clickthrough_spec.rb +1 -1
  149. data/spec/integration/app-search/meta_engines_spec.rb +5 -5
  150. data/spec/integration/app-search/search_and_multiple_search_spec.rb +1 -1
  151. data/spec/integration/workplace-search/content_sources_spec.rb +6 -6
  152. data/spec/integration/workplace-search/documents_spec.rb +20 -10
  153. data/spec/integration/workplace-search/external_identities_spec.rb +26 -16
  154. data/spec/integration/workplace-search/triggers_spec.rb +2 -2
  155. data/spec/integration/workplace-search/users_spec.rb +0 -6
  156. data/spec/workplace-search/client_spec.rb +29 -0
  157. metadata +30 -21
  158. data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml +0 -12
  159. data/.github/compatibility/Gemfile +0 -23
  160. data/.github/workflows/compatibility.yml +0 -20
  161. data/spec/integration/workplace-search/permissions_spec.rb +0 -77
@@ -1,23 +0,0 @@
1
- # Licensed to Elasticsearch B.V. under one or more contributor
2
- # license agreements. See the NOTICE file distributed with
3
- # this work for additional information regarding copyright
4
- # ownership. Elasticsearch B.V. licenses this file to you under
5
- # the Apache License, Version 2.0 (the "License"); you may
6
- # not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # http://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing,
12
- # software distributed under the License is distributed on an
13
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
- # KIND, either express or implied. See the License for the
15
- # specific language governing permissions and limitations
16
- # under the License.
17
-
18
- # frozen_string_literal: true
19
-
20
- source 'https://rubygems.org'
21
-
22
- gem 'elasticsearch', ENV['es-version']
23
- gem 'elastic-enterprise-search', path: File.expand_path('../../', __dir__)
@@ -1,20 +0,0 @@
1
- name: Compatibility with Elasticsearch
2
- on: [push, pull_request]
3
-
4
- jobs:
5
- elasticsearch:
6
- env:
7
- ES_VERSION: ${{ matrix.es_version }}
8
- strategy:
9
- matrix:
10
- es_version: [ 7.11, 7.12, 7.13, 7.14, 7.15, 7.16 ]
11
- runs-on: ubuntu-latest
12
- steps:
13
- - uses: actions/checkout@v2
14
- - uses: ruby/setup-ruby@v1
15
- with:
16
- ruby-version: 3.1
17
- - name: Build Gemfile with Elasticsearch gem
18
- run: |
19
- ruby -v
20
- cd ./.github/compatibility/ && bundle
@@ -1,77 +0,0 @@
1
- # Licensed to Elasticsearch B.V. under one or more contributor
2
- # license agreements. See the NOTICE file distributed with
3
- # this work for additional information regarding copyright
4
- # ownership. Elasticsearch B.V. licenses this file to you under
5
- # the Apache License, Version 2.0 (the "License"); you may
6
- # not use this file except in compliance with the License.
7
- # You may obtain a copy of the License at
8
- #
9
- # http://www.apache.org/licenses/LICENSE-2.0
10
- #
11
- # Unless required by applicable law or agreed to in writing,
12
- # software distributed under the License is distributed on an
13
- # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
- # KIND, either express or implied. See the License for the
15
- # specific language governing permissions and limitations
16
- # under the License.
17
-
18
- # frozen_string_literal: true
19
-
20
- require_relative "#{__dir__}/workplace_search_helper.rb"
21
-
22
- describe Elastic::EnterpriseSearch::WorkplaceSearch::Client do
23
- context 'Permissions' do
24
- let(:content_source_id) { client.create_content_source(name: 'my_content').body['id'] }
25
- let(:user) { 'enterprise_search' }
26
- let(:permissions) { ['permission1', 'permission2'] }
27
-
28
- after do
29
- client.put_user_permissions(content_source_id, { permissions: [], user: user })
30
- delete_content_sources
31
- end
32
-
33
- it 'adds permissions to a user' do
34
- response = client.add_user_permissions(
35
- content_source_id,
36
- { permissions: permissions, user: user }
37
- )
38
- expect(response.status).to eq 200
39
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => ['permission1', 'permission2'] })
40
- end
41
-
42
- it 'removes permissions from a user' do
43
- client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
44
-
45
- # Removes Permissions
46
- response = client.remove_user_permissions(
47
- content_source_id,
48
- { permissions: permissions, user: user }
49
- )
50
- expect(response.status).to eq 200
51
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
52
- end
53
-
54
- it 'lists permissions' do
55
- response = client.list_permissions(content_source_id)
56
- expect(response.status).to eq 200
57
- end
58
-
59
- it 'gets a user\'s permissions' do
60
- client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
61
- response = client.user_permissions(content_source_id, { user: user })
62
- expect(response.status).to eq 200
63
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
64
- end
65
-
66
- it 'updates a user\'s permissions' do
67
- permissions = ['testing', 'more', 'permissions']
68
- response = client.add_user_permissions(content_source_id, { permissions: permissions, user: user })
69
- expect(response.status).to eq 200
70
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => permissions })
71
-
72
- response = client.put_user_permissions(content_source_id, { permissions: [], user: user })
73
- expect(response.status).to eq 200
74
- expect(response.body).to eq({ 'user' => 'enterprise_search', 'permissions' => [] })
75
- end
76
- end
77
- end