elastic-enterprise-search 7.12.1 → 7.15.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (236) 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+7.10.0.beta.1.yml +12 -0
  5. data/.ci/jobs/{elastic+enterprise-search-ruby+7.11.yml → elastic+enterprise-search-ruby+main.yml} +4 -4
  6. data/.ci/make.sh +162 -0
  7. data/.ci/run-repository.sh +2 -1
  8. data/.ci/test-matrix.yml +5 -3
  9. data/{spec/app-search/api_logs_spec.rb → .github/check_license_headers.rb} +13 -16
  10. data/.github/license-header.txt +16 -0
  11. data/.github/workflows/license.yml +13 -0
  12. data/.github/workflows/testing.yml +1 -1
  13. data/CONTRIBUTING.md +1 -1
  14. data/README.md +1 -1
  15. data/Rakefile +20 -0
  16. data/docs/guide/app-search-api.asciidoc +157 -1
  17. data/docs/guide/connecting.asciidoc +47 -1
  18. data/docs/guide/overview.asciidoc +3 -3
  19. data/docs/guide/release_notes/712.asciidoc +0 -10
  20. data/docs/guide/release_notes/713.asciidoc +21 -0
  21. data/docs/guide/release_notes/714.asciidoc +21 -0
  22. data/docs/guide/release_notes/715.asciidoc +36 -0
  23. data/docs/guide/release_notes/index.asciidoc +6 -0
  24. data/docs/guide/workplace-search-api.asciidoc +115 -2
  25. data/elastic-enterprise-search.gemspec +1 -1
  26. data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -2
  27. data/lib/elastic/app-search/api/api_key.rb +52 -0
  28. data/lib/elastic/app-search/api/api_logs.rb +14 -13
  29. data/lib/elastic/app-search/api/count_analytics.rb +7 -6
  30. data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +51 -0
  31. data/lib/elastic/app-search/api/crawler_crawl_request.rb +54 -0
  32. data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +51 -0
  33. data/lib/elastic/app-search/api/crawler_domain.rb +54 -0
  34. data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +48 -0
  35. data/lib/elastic/app-search/api/crawler_metrics.rb +48 -0
  36. data/lib/elastic/app-search/api/crawler_overview.rb +51 -0
  37. data/lib/elastic/app-search/api/crawler_process_crawl.rb +54 -0
  38. data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +54 -0
  39. data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +52 -0
  40. data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +52 -0
  41. data/lib/elastic/app-search/api/crawler_url_validation_result.rb +52 -0
  42. data/lib/elastic/app-search/api/crawler_user_agent.rb +48 -0
  43. data/lib/elastic/app-search/api/create_api_key.rb +57 -0
  44. data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +51 -0
  45. data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +59 -0
  46. data/lib/elastic/app-search/api/create_crawler_domain.rb +55 -0
  47. data/lib/elastic/app-search/api/create_crawler_entry_point.rb +56 -0
  48. data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +53 -0
  49. data/lib/elastic/app-search/api/create_crawler_sitemap.rb +56 -0
  50. data/lib/elastic/app-search/api/create_curation.rb +7 -6
  51. data/lib/elastic/app-search/api/create_engine.rb +9 -7
  52. data/lib/elastic/app-search/api/create_synonym_set.rb +7 -4
  53. data/lib/elastic/app-search/api/curation.rb +4 -3
  54. data/lib/elastic/app-search/api/delete_active_crawl_request.rb +51 -0
  55. data/lib/elastic/app-search/api/delete_api_key.rb +52 -0
  56. data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +51 -0
  57. data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +57 -0
  58. data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +51 -0
  59. data/lib/elastic/app-search/api/delete_crawler_domain.rb +54 -0
  60. data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +57 -0
  61. data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +57 -0
  62. data/lib/elastic/app-search/api/delete_curation.rb +4 -3
  63. data/lib/elastic/app-search/api/delete_documents.rb +2 -1
  64. data/lib/elastic/app-search/api/delete_engine.rb +3 -2
  65. data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -3
  66. data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -3
  67. data/lib/elastic/app-search/api/denied_urls.rb +54 -0
  68. data/lib/elastic/app-search/api/documents.rb +3 -2
  69. data/lib/elastic/app-search/api/engine.rb +3 -2
  70. data/lib/elastic/app-search/api/index_documents.rb +3 -2
  71. data/lib/elastic/app-search/api/list_api_keys.rb +50 -0
  72. data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +52 -0
  73. data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +51 -0
  74. data/lib/elastic/app-search/api/list_curations.rb +3 -2
  75. data/lib/elastic/app-search/api/list_documents.rb +3 -2
  76. data/lib/elastic/app-search/api/list_engines.rb +2 -1
  77. data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -2
  78. data/lib/elastic/app-search/api/log_clickthrough.rb +8 -10
  79. data/lib/elastic/app-search/api/put_api_key.rb +59 -0
  80. data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +62 -0
  81. data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +53 -0
  82. data/lib/elastic/app-search/api/put_crawler_domain.rb +58 -0
  83. data/lib/elastic/app-search/api/put_crawler_entry_point.rb +59 -0
  84. data/lib/elastic/app-search/api/put_crawler_sitemap.rb +59 -0
  85. data/lib/elastic/app-search/api/put_curation.rb +9 -8
  86. data/lib/elastic/app-search/api/put_documents.rb +3 -3
  87. data/lib/elastic/app-search/api/put_schema.rb +4 -4
  88. data/lib/elastic/app-search/api/put_search_settings.rb +6 -2
  89. data/lib/elastic/app-search/api/put_synonym_set.rb +8 -5
  90. data/lib/elastic/app-search/api/query_suggestion.rb +7 -7
  91. data/lib/elastic/app-search/api/reset_search_settings.rb +3 -2
  92. data/lib/elastic/app-search/api/schema.rb +3 -2
  93. data/lib/elastic/app-search/api/search.rb +14 -3
  94. data/lib/elastic/app-search/api/search_settings.rb +3 -2
  95. data/lib/elastic/app-search/api/synonym_set.rb +4 -3
  96. data/lib/elastic/app-search/api/top_clicks_analytics.rb +8 -8
  97. data/lib/elastic/app-search/api/top_queries_analytics.rb +7 -7
  98. data/lib/elastic/app-search/app_search.rb +0 -10
  99. data/lib/elastic/enterprise-search/api/health.rb +1 -0
  100. data/lib/elastic/enterprise-search/api/put_read_only.rb +3 -0
  101. data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
  102. data/lib/elastic/enterprise-search/api/version.rb +1 -0
  103. data/lib/elastic/enterprise-search/client.rb +0 -16
  104. data/lib/elastic/enterprise-search/request.rb +14 -3
  105. data/lib/elastic/enterprise-search/version.rb +1 -1
  106. data/lib/elastic/enterprise_search.rb +11 -0
  107. data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +49 -0
  108. data/lib/elastic/workplace-search/api/command_sync_jobs.rb +53 -0
  109. data/lib/elastic/workplace-search/api/content_source.rb +49 -0
  110. data/lib/elastic/workplace-search/api/create_analytics_event.rb +8 -8
  111. data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +50 -0
  112. data/lib/elastic/workplace-search/api/create_content_source.rb +55 -0
  113. data/lib/elastic/workplace-search/api/create_external_identity.rb +3 -1
  114. data/lib/elastic/workplace-search/api/current_user.rb +47 -0
  115. data/lib/elastic/workplace-search/api/delete_all_documents.rb +49 -0
  116. data/lib/elastic/workplace-search/api/delete_content_source.rb +49 -0
  117. data/lib/elastic/workplace-search/api/delete_documents.rb +1 -1
  118. data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +50 -0
  119. data/lib/elastic/workplace-search/api/delete_synonym_set.rb +51 -0
  120. data/lib/elastic/workplace-search/api/document.rb +53 -0
  121. data/lib/elastic/workplace-search/api/list_content_sources.rb +48 -0
  122. data/lib/elastic/workplace-search/api/list_synonym_sets.rb +51 -0
  123. data/lib/elastic/workplace-search/api/put_content_source.rb +58 -0
  124. data/lib/elastic/workplace-search/api/put_content_source_icons.rb +53 -0
  125. data/lib/elastic/workplace-search/api/put_external_identity.rb +3 -1
  126. data/lib/elastic/workplace-search/api/put_synonym_set.rb +53 -0
  127. data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +47 -0
  128. data/lib/elastic/workplace-search/api/search.rb +4 -1
  129. data/lib/elastic/workplace-search/api/synonym_set.rb +51 -0
  130. data/lib/elastic/workplace-search/api/triggers_blocklist.rb +45 -0
  131. data/lib/elastic/workplace-search/workplace_search.rb +0 -10
  132. data/rake_tasks/unified_release_tasks.rake +46 -0
  133. data/spec/enterprise-search/client_spec.rb +0 -1
  134. data/spec/enterprise-search/request_spec.rb +26 -0
  135. data/spec/integration/app-search/api_key_spec.rb +110 -0
  136. data/spec/integration/app-search/api_logs_spec.rb +59 -0
  137. data/spec/integration/app-search/app_search_helper.rb +39 -0
  138. data/spec/integration/app-search/count_analytics_spec.rb +47 -0
  139. data/spec/integration/app-search/crawl_requests_spec.rb +86 -0
  140. data/spec/integration/app-search/crawler_crawl_rule_spec.rb +73 -0
  141. data/spec/integration/app-search/crawler_domain_spec.rb +82 -0
  142. data/spec/integration/app-search/crawler_entry_point_spec.rb +89 -0
  143. data/spec/integration/app-search/crawler_metrics_spec.rb +46 -0
  144. data/spec/integration/app-search/crawler_overview_spec.rb +45 -0
  145. data/spec/integration/app-search/crawler_process_crawl_denied_urls_spec.rb +50 -0
  146. data/spec/integration/app-search/crawler_process_crawl_spec.rb +66 -0
  147. data/spec/integration/app-search/crawler_scheduling_spec.rb +81 -0
  148. data/spec/integration/app-search/crawler_sitemap_spec.rb +72 -0
  149. data/spec/integration/app-search/crawler_urls_spec.rb +60 -0
  150. data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb} +6 -9
  151. data/spec/integration/app-search/curations_spec.rb +118 -0
  152. data/spec/integration/app-search/documents_spec.rb +123 -0
  153. data/spec/integration/app-search/engines_spec.rb +77 -0
  154. data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb} +14 -7
  155. data/spec/integration/app-search/meta_engines_spec.rb +75 -0
  156. data/spec/integration/app-search/query_suggestion_spec.rb +50 -0
  157. data/spec/{app-search/api_schema_spec.rb → integration/app-search/schema_spec.rb} +21 -16
  158. data/spec/integration/app-search/search_and_multiple_search_spec.rb +67 -0
  159. data/spec/integration/app-search/search_settings_spec.rb +87 -0
  160. data/spec/integration/app-search/synonyms_spec.rb +79 -0
  161. data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb} +20 -14
  162. data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb} +16 -8
  163. data/spec/integration/enterprise_search_api_spec.rb +4 -0
  164. data/spec/integration/workplace-search/content_sources_spec.rb +106 -0
  165. data/spec/integration/workplace-search/documents_spec.rb +95 -0
  166. data/spec/{workplace-search → integration/workplace-search}/external_identities_spec.rb +37 -24
  167. data/spec/integration/workplace-search/icon.png +0 -0
  168. data/spec/integration/workplace-search/permissions_spec.rb +77 -0
  169. data/spec/integration/workplace-search/synonym_sets_spec.rb +92 -0
  170. data/spec/integration/workplace-search/triggers_spec.rb +43 -0
  171. data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb} +12 -15
  172. data/spec/integration/workplace-search/workplace_search_helper.rb +39 -0
  173. data/spec/webmock_requires.rb +16 -0
  174. data/spec/workplace-search/client_spec.rb +24 -2
  175. metadata +112 -83
  176. data/.ci/jobs/elastic+enterprise-search-ruby+master.yml +0 -12
  177. data/spec/app-search/api_curations_spec.rb +0 -97
  178. data/spec/app-search/api_documents_spec.rb +0 -102
  179. data/spec/app-search/api_engines_spec.rb +0 -67
  180. data/spec/app-search/api_meta_engines_spec.rb +0 -72
  181. data/spec/app-search/api_search_and_multi_search_spec.rb +0 -48
  182. data/spec/app-search/api_search_settings_spec.rb +0 -76
  183. data/spec/app-search/api_spec_helper.rb +0 -14
  184. data/spec/app-search/api_synonyms_spec.rb +0 -79
  185. data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +0 -109
  186. data/spec/fixtures/vcr/app_search/api_documents.yml +0 -56
  187. data/spec/fixtures/vcr/app_search/api_index_documents.yml +0 -57
  188. data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +0 -54
  189. data/spec/fixtures/vcr/app_search/api_logs.yml +0 -70
  190. data/spec/fixtures/vcr/app_search/api_put_schema.yml +0 -109
  191. data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +0 -56
  192. data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +0 -59
  193. data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +0 -56
  194. data/spec/fixtures/vcr/app_search/api_schema.yml +0 -56
  195. data/spec/fixtures/vcr/app_search/api_search_settings.yml +0 -56
  196. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +0 -55
  197. data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +0 -55
  198. data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +0 -55
  199. data/spec/fixtures/vcr/app_search/count_analytics.yml +0 -55
  200. data/spec/fixtures/vcr/app_search/create_and_update_document.yml +0 -107
  201. data/spec/fixtures/vcr/app_search/create_curation.yml +0 -113
  202. data/spec/fixtures/vcr/app_search/create_engine.yml +0 -55
  203. data/spec/fixtures/vcr/app_search/create_meta_engine.yml +0 -56
  204. data/spec/fixtures/vcr/app_search/create_synonym_set.yml +0 -56
  205. data/spec/fixtures/vcr/app_search/delete_curation.yml +0 -56
  206. data/spec/fixtures/vcr/app_search/delete_engine.yml +0 -55
  207. data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +0 -56
  208. data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +0 -56
  209. data/spec/fixtures/vcr/app_search/get_curation.yml +0 -56
  210. data/spec/fixtures/vcr/app_search/get_engine.yml +0 -55
  211. data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +0 -107
  212. data/spec/fixtures/vcr/app_search/list_curations.yml +0 -56
  213. data/spec/fixtures/vcr/app_search/list_documents.yml +0 -57
  214. data/spec/fixtures/vcr/app_search/list_engines.yml +0 -55
  215. data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +0 -56
  216. data/spec/fixtures/vcr/app_search/multi_query_search.yml +0 -63
  217. data/spec/fixtures/vcr/app_search/put_curation.yml +0 -113
  218. data/spec/fixtures/vcr/app_search/put_synonym_set.yml +0 -56
  219. data/spec/fixtures/vcr/app_search/search.yml +0 -57
  220. data/spec/fixtures/vcr/app_search/single_query_search.yml +0 -60
  221. data/spec/fixtures/vcr/app_search/synonym_set.yml +0 -56
  222. data/spec/fixtures/vcr/workplace_search/add_user_permissions.yml +0 -53
  223. data/spec/fixtures/vcr/workplace_search/clear_user_permissions.yml +0 -53
  224. data/spec/fixtures/vcr/workplace_search/create_external_identity.yml +0 -53
  225. data/spec/fixtures/vcr/workplace_search/delete_documents.yml +0 -53
  226. data/spec/fixtures/vcr/workplace_search/delete_external_identity.yml +0 -53
  227. data/spec/fixtures/vcr/workplace_search/index_documents.yml +0 -55
  228. data/spec/fixtures/vcr/workplace_search/list_external_identities.yml +0 -53
  229. data/spec/fixtures/vcr/workplace_search/list_permissions.yml +0 -53
  230. data/spec/fixtures/vcr/workplace_search/put_external_identity.yml +0 -53
  231. data/spec/fixtures/vcr/workplace_search/put_user_permissions.yml +0 -103
  232. data/spec/fixtures/vcr/workplace_search/remove_user_permissions.yml +0 -53
  233. data/spec/fixtures/vcr/workplace_search/retrieve_external_identity.yml +0 -53
  234. data/spec/fixtures/vcr/workplace_search/user_permissions_empty.yml +0 -53
  235. data/spec/workplace-search/documents_spec.rb +0 -80
  236. data/spec/workplace-search/permissions_spec.rb +0 -136
@@ -0,0 +1,56 @@
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 - Create a crawler entry point
25
+ # Creates a crawler domain entry point for a given engine and domain
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
30
+ # @option arguments [Hash] :body (Required: value)
31
+ # @option body [String] :id
32
+ # @option body [String] :value (*Required)
33
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
34
+ #
35
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-entry-points
36
+ #
37
+ def create_crawler_entry_point(engine_name, arguments = {})
38
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
39
+ raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
40
+
41
+ domain_id = arguments[:domain_id]
42
+ body = arguments.delete(:body) || {}
43
+ headers = arguments.delete(:headers) || {}
44
+
45
+ request(
46
+ :post,
47
+ "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/entry_points/",
48
+ arguments,
49
+ body,
50
+ headers
51
+ )
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,53 @@
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 - Create a process crawl
25
+ # Queues a task to reprocess crawled documents with current crawl configuration
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [Hash] :body
30
+ # @option body [Boolean] :dry_run
31
+ # @option body [Array] :domains
32
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
+ #
34
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-process-crawls
35
+ #
36
+ def create_crawler_process_crawl(engine_name, arguments = {})
37
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
+
39
+ body = arguments.delete(:body) || {}
40
+ headers = arguments.delete(:headers) || {}
41
+
42
+ request(
43
+ :post,
44
+ "api/as/v0/engines/#{engine_name}/crawler/process_crawls/",
45
+ arguments,
46
+ body,
47
+ headers
48
+ )
49
+ end
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,56 @@
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 - Create a crawler sitemap
25
+ # Creates a crawler sitemap configuration for a given engine and domain
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
30
+ # @option arguments [Hash] :body (Required: url)
31
+ # @option body [String] :id
32
+ # @option body [String] :url (*Required)
33
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
34
+ #
35
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-sitemaps
36
+ #
37
+ def create_crawler_sitemap(engine_name, arguments = {})
38
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
39
+ raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
40
+
41
+ domain_id = arguments[:domain_id]
42
+ body = arguments.delete(:body) || {}
43
+ headers = arguments.delete(:headers) || {}
44
+
45
+ request(
46
+ :post,
47
+ "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/sitemaps/",
48
+ arguments,
49
+ body,
50
+ headers
51
+ )
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -22,19 +22,20 @@ module Elastic
22
22
  module AppSearch
23
23
  module Actions
24
24
  # Curations - Create a new curation
25
+ # Create a new curation for the 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
- # @option arguments [Array] :queries List of affected search queries (*Required*)
29
- # @option arguments :promoted_doc_ids List of promoted document IDs
30
- # @option arguments :hidden_doc_ids List of hidden document IDs
31
- # @option arguments [Hash] :body The request body
29
+ # @option arguments [Hash] :body (Required: queries)
30
+ # @option body [String] :id
31
+ # @option body [Array] :queries List of affected search queries (*Required)
32
+ # @option body [Array] :promoted List of promoted document IDs
33
+ # @option body [Array] :hidden List of hidden document IDs
32
34
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
35
  #
34
36
  # @see https://www.elastic.co/guide/en/app-search/current/curations.html#curations-create
35
37
  #
36
38
  def create_curation(engine_name, arguments = {})
37
- raise ArgumentError, "Required parameter 'queries' missing" unless arguments[:queries]
38
39
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
39
40
 
40
41
  body = arguments.delete(:body) || {}
@@ -21,20 +21,22 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Engine - Creates a new engine
24
+ # Engines - Create an Engine
25
+ # Creates an App Search Engine
25
26
  #
26
27
  # @param arguments [Hash] endpoint arguments
27
- # @option arguments [String] :name Engine name (*Required*)
28
- # @option arguments [String] :language Engine language (null for universal)
29
- # @option arguments [String] :type Engine type
30
- # @option arguments [Array] :source_engines Sources engines list
31
- # @option arguments [Hash] :body The request body
28
+ # @option arguments [Hash] :body (Required: name)
29
+ # @option body :name (*Required)
30
+ # @option body [String] :language Engine language (null for universal)
31
+ # @option body :type
32
+ # @option body :source_engines
33
+ # @option body [Integer] :document_count
32
34
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
35
  #
34
36
  # @see https://www.elastic.co/guide/en/app-search/current/engines.html#engines-create
35
37
  #
36
38
  def create_engine(arguments = {})
37
- raise ArgumentError, "Required parameter 'name' missing" unless arguments[:name]
39
+ raise ArgumentError, "Required parameter 'body (name)' missing" unless arguments[:body] || arguments[:name]
38
40
 
39
41
  body = arguments.delete(:body) || {}
40
42
  headers = arguments.delete(:headers) || {}
@@ -21,18 +21,21 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Synonyms - Create a new synonym set
24
+ # Synonyms - Create a synonym set
25
+ # Creates a new synonym set for the 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
- # @option arguments [Object] :body Synonym set description (*Required*)
29
+ # @option arguments [Hash] :body (Required: synonyms)
30
+ # @option body [String] :id
31
+ # @option body :synonyms (*Required)
29
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
33
  #
31
34
  # @see https://www.elastic.co/guide/en/app-search/current/synonyms.html#synonyms-create
32
35
  #
33
36
  def create_synonym_set(engine_name, arguments = {})
34
37
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
35
- raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
38
+ raise ArgumentError, "Required parameter 'body (synonyms)' missing" unless arguments[:body]
36
39
 
37
40
  body = arguments.delete(:body) || {}
38
41
  headers = arguments.delete(:headers) || {}
@@ -21,11 +21,12 @@ module Elastic
21
21
  module EnterpriseSearch
22
22
  module AppSearch
23
23
  module Actions
24
- # Curations - Retrieve a curation by ID
24
+ # Curations - Retrieve a curation
25
+ # Retrieves a curation by ID
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] :curation_id (*Required*)
29
+ # @option arguments [String] :curation_id Curation ID (*Required*)
29
30
  # @option arguments [Hash] :body The request body
30
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
32
  #
@@ -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 - Cancel an active crawl request
25
+ # Cancels an active crawl request, stopping a running crawl if needed.
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-post-crawler-crawl-requests-active-cancel
33
+ #
34
+ def delete_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
+ :post,
42
+ "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/cancel/",
43
+ arguments,
44
+ body,
45
+ headers
46
+ )
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,52 @@
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
+ # Credentials - Delete an API key
25
+ # Deletes a given API key
26
+ #
27
+ # @param arguments [Hash] endpoint arguments
28
+ # @option arguments [String] :api_key_name Name of an API key (*Required*)
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/credentials.html#credentials-destroy
33
+ #
34
+ def delete_api_key(arguments = {})
35
+ raise ArgumentError, "Required parameter 'api_key_name' missing" unless arguments[:api_key_name]
36
+
37
+ api_key_name = arguments[:api_key_name]
38
+ body = arguments.delete(:body) || {}
39
+ headers = arguments.delete(:headers) || {}
40
+
41
+ request(
42
+ :delete,
43
+ "api/as/v1/credentials/#{api_key_name}/",
44
+ arguments,
45
+ body,
46
+ headers
47
+ )
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
@@ -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 - Cancel an active crawl request
25
+ # Cancels an active crawl request, stopping a running crawl if needed.
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-post-crawler-crawl-requests-active-cancel
33
+ #
34
+ def delete_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
+ :post,
42
+ "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/cancel/",
43
+ arguments,
44
+ body,
45
+ headers
46
+ )
47
+ end
48
+ end
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,57 @@
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 - Delete a crawl rule
25
+ # Deletes a crawl rule from a given domain
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
30
+ # @option arguments [String] :crawl_rule_id Crawl Rule ID (*Required*)
31
+ # @option arguments [Hash] :body The request body
32
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
+ #
34
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-delete-crawl-rule
35
+ #
36
+ def delete_crawler_crawl_rule(engine_name, arguments = {})
37
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
+ raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
39
+ raise ArgumentError, "Required parameter 'crawl_rule_id' missing" unless arguments[:crawl_rule_id]
40
+
41
+ domain_id = arguments[:domain_id]
42
+ crawl_rule_id = arguments[:crawl_rule_id]
43
+ body = arguments.delete(:body) || {}
44
+ headers = arguments.delete(:headers) || {}
45
+
46
+ request(
47
+ :delete,
48
+ "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/crawl_rules/#{crawl_rule_id}/",
49
+ arguments,
50
+ body,
51
+ headers
52
+ )
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -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 - Delete a crawl schedule
25
+ # Deletes a crawl schedule for a given engine
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-delete-crawler-crawl-schedule
33
+ #
34
+ def delete_crawler_crawl_schedule(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
+ :delete,
42
+ "api/as/v0/engines/#{engine_name}/crawler/crawl_schedule/",
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 - Delete domain configuration
25
+ # Deletes crawler domain configuration for a given domain
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [String] :domain_id Crawler Domain 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-delete-crawler-domain
34
+ #
35
+ def delete_crawler_domain(engine_name, arguments = {})
36
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
+ raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
38
+
39
+ domain_id = arguments[:domain_id]
40
+ body = arguments.delete(:body) || {}
41
+ headers = arguments.delete(:headers) || {}
42
+
43
+ request(
44
+ :delete,
45
+ "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/",
46
+ arguments,
47
+ body,
48
+ headers
49
+ )
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,57 @@
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 - Delete an entry point
25
+ # Deletes a crawler entry point
26
+ #
27
+ # @param engine_name [String] Name of the engine (*Required*)
28
+ # @param arguments [Hash] endpoint arguments
29
+ # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
30
+ # @option arguments [String] :entry_point_id Crawler Entry Point identifier (*Required*)
31
+ # @option arguments [Hash] :body The request body
32
+ # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
+ #
34
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-delete-crawler-domain
35
+ #
36
+ def delete_crawler_entry_point(engine_name, arguments = {})
37
+ raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
+ raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
39
+ raise ArgumentError, "Required parameter 'entry_point_id' missing" unless arguments[:entry_point_id]
40
+
41
+ domain_id = arguments[:domain_id]
42
+ entry_point_id = arguments[:entry_point_id]
43
+ body = arguments.delete(:body) || {}
44
+ headers = arguments.delete(:headers) || {}
45
+
46
+ request(
47
+ :delete,
48
+ "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/entry_points/#{entry_point_id}/",
49
+ arguments,
50
+ body,
51
+ headers
52
+ )
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end