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
@@ -24,31 +24,24 @@ module Elastic
24
24
  # APILogs - Retrieve API logs
25
25
  # The API Log displays API request and response data at the Engine level
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
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.
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Hash] :body (Required: filters)
35
30
  # @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
31
+ # @option body :page
32
+ # @option body [string] :query
33
+ # @option body :sort_direction
38
34
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
39
35
  #
40
36
  # @see https://www.elastic.co/guide/en/app-search/current/api-logs.html
41
37
  #
42
38
  def api_logs(engine_name, arguments = {})
43
39
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
44
- raise ArgumentError, "Required parameter 'from_date' missing" unless arguments[:from_date]
45
- raise ArgumentError, "Required parameter 'to_date' missing" unless arguments[:to_date]
40
+ raise ArgumentError, "Required parameter 'body (filters)' missing" unless arguments[:body]
46
41
 
47
42
  body = arguments.delete(:body) || {}
48
- headers = arguments.delete(:headers) || {}
49
- arguments['filters[date][from]'] = date_to_rfc3339(arguments.delete(:from_date))
50
- arguments['filters[date][to]'] = date_to_rfc3339(arguments.delete(:to_date))
51
43
 
44
+ headers = arguments.delete(:headers) || {}
52
45
  request(
53
46
  :post,
54
47
  "api/as/v1/engines/#{engine_name}/logs/api/",
@@ -24,11 +24,11 @@ module Elastic
24
24
  # Analytics - Query for analytics counts data
25
25
  # Returns the number of clicks and total number of queries over a period
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
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
30
+ # @option body :filters
31
+ # @option body [string] :interval
32
32
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
33
33
  #
34
34
  # @see https://www.elastic.co/guide/en/app-search/current/counts.html
@@ -37,8 +37,8 @@ module Elastic
37
37
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
38
38
 
39
39
  body = arguments.delete(:body) || {}
40
- headers = arguments.delete(:headers) || {}
41
40
 
41
+ headers = arguments.delete(:headers) || {}
42
42
  request(
43
43
  :post,
44
44
  "api/as/v1/engines/#{engine_name}/analytics/counts/",
@@ -24,9 +24,8 @@ module Elastic
24
24
  # Crawler - Get active crawl request details
25
25
  # Returns active crawl request details.
26
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
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
30
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-active
@@ -34,14 +33,12 @@ module Elastic
34
33
  def crawler_active_crawl_request(engine_name, arguments = {})
35
34
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
35
 
37
- body = arguments.delete(:body) || {}
38
36
  headers = arguments.delete(:headers) || {}
39
-
40
37
  request(
41
38
  :get,
42
- "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/active/",
39
+ "api/as/v1/engines/#{engine_name}/crawler/crawl_requests/active/",
43
40
  arguments,
44
- body,
41
+ nil,
45
42
  headers
46
43
  )
47
44
  end
@@ -24,10 +24,9 @@ module Elastic
24
24
  # Crawler - Get crawl request details
25
25
  # Returns crawl request details.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [String] :crawl_request_id Crawl Request ID (*Required*)
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests-id
@@ -36,15 +35,14 @@ module Elastic
36
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
36
  raise ArgumentError, "Required parameter 'crawl_request_id' missing" unless arguments[:crawl_request_id]
38
37
 
39
- crawl_request_id = arguments[:crawl_request_id]
40
- body = arguments.delete(:body) || {}
41
- headers = arguments.delete(:headers) || {}
38
+ crawl_request_id = arguments.delete(:crawl_request_id)
42
39
 
40
+ headers = arguments.delete(:headers) || {}
43
41
  request(
44
42
  :get,
45
- "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/crawl_requests/#{crawl_request_id}/",
46
44
  arguments,
47
- body,
45
+ nil,
48
46
  headers
49
47
  )
50
48
  end
@@ -24,9 +24,8 @@ module Elastic
24
24
  # Crawler - Get crawl schedule
25
25
  # Returns the current crawl schedule for a given engine
26
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
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
30
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-schedule
@@ -34,14 +33,12 @@ module Elastic
34
33
  def crawler_crawl_schedule(engine_name, arguments = {})
35
34
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
35
 
37
- body = arguments.delete(:body) || {}
38
36
  headers = arguments.delete(:headers) || {}
39
-
40
37
  request(
41
38
  :get,
42
- "api/as/v0/engines/#{engine_name}/crawler/crawl_schedule/",
39
+ "api/as/v1/engines/#{engine_name}/crawler/crawl_schedule/",
43
40
  arguments,
44
- body,
41
+ nil,
45
42
  headers
46
43
  )
47
44
  end
@@ -24,10 +24,9 @@ module Elastic
24
24
  # Crawler - Get domain configuration
25
25
  # Returns crawler domain configuration details
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-domain
@@ -36,15 +35,14 @@ module Elastic
36
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
36
  raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
38
37
 
39
- domain_id = arguments[:domain_id]
40
- body = arguments.delete(:body) || {}
41
- headers = arguments.delete(:headers) || {}
38
+ domain_id = arguments.delete(:domain_id)
42
39
 
40
+ headers = arguments.delete(:headers) || {}
43
41
  request(
44
42
  :get,
45
- "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/domains/#{domain_id}/",
46
44
  arguments,
47
- body,
45
+ nil,
48
46
  headers
49
47
  )
50
48
  end
@@ -24,19 +24,20 @@ module Elastic
24
24
  # Crawler - Validate Domain with Crawler
25
25
  # Performs a number of checks on a given domain name to make sure it is ready to be crawled and ingested into App Search.
26
26
  #
27
- # @param arguments [Hash] endpoint arguments
28
- # @option arguments [String] :body
27
+ # @param [Hash] arguments endpoint arguments
28
+ # @option arguments [string] :body
29
+ # @option body [string] :url *Required*
29
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
31
  #
31
- # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
32
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-domain
32
33
  #
33
34
  def crawler_domain_validation_result(arguments = {})
34
35
  body = arguments.delete(:body) || {}
35
- headers = arguments.delete(:headers) || {}
36
36
 
37
+ headers = arguments.delete(:headers) || {}
37
38
  request(
38
39
  :post,
39
- 'api/as/v0/crawler/validate_url/',
40
+ 'api/as/v1/crawler/validate_url/',
40
41
  arguments,
41
42
  body,
42
43
  headers
@@ -24,21 +24,18 @@ module Elastic
24
24
  # Crawler - Retrieve a snapshot of crawler metrics
25
25
  # Retrieves a momentary snapshot of key crawler metrics, including global and node-level crawler health
26
26
  #
27
- # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Hash] :body The request body
27
+ # @param [Hash] arguments endpoint arguments
29
28
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
29
  #
31
30
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
32
31
  #
33
32
  def crawler_metrics(arguments = {})
34
- body = arguments.delete(:body) || {}
35
33
  headers = arguments.delete(:headers) || {}
36
-
37
34
  request(
38
35
  :get,
39
- 'api/as/v0/crawler/metrics/',
36
+ 'api/as/v1/crawler/metrics/',
40
37
  arguments,
41
- body,
38
+ nil,
42
39
  headers
43
40
  )
44
41
  end
@@ -24,9 +24,8 @@ module Elastic
24
24
  # Crawler - Retrieve crawler configuration overview
25
25
  # Retrieves crawler configuration overview of a given engine, including configured domains
26
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
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
30
29
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
30
  #
32
31
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler
@@ -34,14 +33,12 @@ module Elastic
34
33
  def crawler_overview(engine_name, arguments = {})
35
34
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
35
 
37
- body = arguments.delete(:body) || {}
38
36
  headers = arguments.delete(:headers) || {}
39
-
40
37
  request(
41
38
  :get,
42
- "api/as/v0/engines/#{engine_name}/crawler/",
39
+ "api/as/v1/engines/#{engine_name}/crawler/",
43
40
  arguments,
44
- body,
41
+ nil,
45
42
  headers
46
43
  )
47
44
  end
@@ -24,10 +24,9 @@ module Elastic
24
24
  # Crawler - Get process crawl details
25
25
  # Returns process crawl details.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [String] :process_crawl_id Process Crawl identifier (*Required*)
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-process-crawls-id
@@ -36,15 +35,14 @@ module Elastic
36
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
36
  raise ArgumentError, "Required parameter 'process_crawl_id' missing" unless arguments[:process_crawl_id]
38
37
 
39
- process_crawl_id = arguments[:process_crawl_id]
40
- body = arguments.delete(:body) || {}
41
- headers = arguments.delete(:headers) || {}
38
+ process_crawl_id = arguments.delete(:process_crawl_id)
42
39
 
40
+ headers = arguments.delete(:headers) || {}
43
41
  request(
44
42
  :get,
45
- "api/as/v0/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/",
46
44
  arguments,
47
- body,
45
+ nil,
48
46
  headers
49
47
  )
50
48
  end
@@ -24,10 +24,9 @@ module Elastic
24
24
  # Crawler - View denied urls for Process Crawl
25
25
  # Provides a sample list of urls identified for deletion by the given process crawl id.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [String] :process_crawl_id Process Crawl identifier (*Required*)
30
- # @option arguments [Hash] :body The request body
31
30
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
31
  #
33
32
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-process-crawls-id-denied-urls
@@ -36,15 +35,14 @@ module Elastic
36
35
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
36
  raise ArgumentError, "Required parameter 'process_crawl_id' missing" unless arguments[:process_crawl_id]
38
37
 
39
- process_crawl_id = arguments[:process_crawl_id]
40
- body = arguments.delete(:body) || {}
41
- headers = arguments.delete(:headers) || {}
38
+ process_crawl_id = arguments.delete(:process_crawl_id)
42
39
 
40
+ headers = arguments.delete(:headers) || {}
43
41
  request(
44
42
  :get,
45
- "api/as/v0/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/denied_urls/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/denied_urls/",
46
44
  arguments,
47
- body,
45
+ nil,
48
46
  headers
49
47
  )
50
48
  end
@@ -24,10 +24,10 @@ module Elastic
24
24
  # Crawler - Extract content from a URL
25
25
  # Performs an HTTP request to a given URL and extracts content from the page using standard App Search Crawler extraction pipeline.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [String] :body
30
- # @option arguments [String] :url (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [string] :body
30
+ # @option body [string] :url *Required*
31
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
32
  #
33
33
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
@@ -36,11 +36,11 @@ module Elastic
36
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
37
 
38
38
  body = arguments.delete(:body) || {}
39
- headers = arguments.delete(:headers) || {}
40
39
 
40
+ headers = arguments.delete(:headers) || {}
41
41
  request(
42
42
  :post,
43
- "api/as/v0/engines/#{engine_name}/crawler/extract_url/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/extract_url/",
44
44
  arguments,
45
45
  body,
46
46
  headers
@@ -24,23 +24,23 @@ module Elastic
24
24
  # Crawler - Trace a history of a crawled URL
25
25
  # Returns information about the history of a given URL with the App Search Crawler.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [String] :body
30
- # @option arguments [String] :url (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [string] :body
30
+ # @option body [string] :url *Required*
31
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
32
  #
33
- # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
33
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-trace-url
34
34
  #
35
35
  def crawler_url_tracing_result(engine_name, arguments = {})
36
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
37
 
38
38
  body = arguments.delete(:body) || {}
39
- headers = arguments.delete(:headers) || {}
40
39
 
40
+ headers = arguments.delete(:headers) || {}
41
41
  request(
42
42
  :post,
43
- "api/as/v0/engines/#{engine_name}/crawler/trace_url/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/trace_url/",
44
44
  arguments,
45
45
  body,
46
46
  headers
@@ -24,23 +24,23 @@ module Elastic
24
24
  # Crawler - Validate URL with Crawler
25
25
  # Performs a number of checks on a given URL to make sure it is ready to be crawled and ingested into App Search.
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
29
- # @option arguments [String] :body
30
- # @option arguments [String] :url (*Required*)
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [string] :body
30
+ # @option body [string] :url *Required*
31
31
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
32
32
  #
33
- # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
33
+ # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-validate-url
34
34
  #
35
35
  def crawler_url_validation_result(engine_name, arguments = {})
36
36
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
37
37
 
38
38
  body = arguments.delete(:body) || {}
39
- headers = arguments.delete(:headers) || {}
40
39
 
40
+ headers = arguments.delete(:headers) || {}
41
41
  request(
42
42
  :post,
43
- "api/as/v0/engines/#{engine_name}/crawler/validate_url/",
43
+ "api/as/v1/engines/#{engine_name}/crawler/validate_url/",
44
44
  arguments,
45
45
  body,
46
46
  headers
@@ -24,21 +24,18 @@ module Elastic
24
24
  # Crawler - Get the User-Agent header value for the crawler
25
25
  # Retrieves the currently configured value for the User-Agent header used for all Crawler HTTP requests
26
26
  #
27
- # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Hash] :body The request body
27
+ # @param [Hash] arguments endpoint arguments
29
28
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
30
29
  #
31
30
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-user-agent
32
31
  #
33
32
  def crawler_user_agent(arguments = {})
34
- body = arguments.delete(:body) || {}
35
33
  headers = arguments.delete(:headers) || {}
36
-
37
34
  request(
38
35
  :get,
39
- 'api/as/v0/crawler/user_agent/',
36
+ 'api/as/v1/crawler/user_agent/',
40
37
  arguments,
41
- body,
38
+ nil,
42
39
  headers
43
40
  )
44
41
  end
@@ -24,25 +24,25 @@ module Elastic
24
24
  # Credentials - Create an API key
25
25
  # Creates an App Search API key
26
26
  #
27
- # @param arguments [Hash] endpoint arguments
28
- # @option arguments [Hash] :body Details of an API key (Required: name, type)
29
- # @option body [String] :id
30
- # @option body [String] :name (*Required)
31
- # @option body [String] :type (*Required)
32
- # @option body [Boolean] :access_all_engines
27
+ # @param [Hash] arguments endpoint arguments
28
+ # @option arguments [Hash] :body (Required: name, type)
29
+ # @option body [string] :id
30
+ # @option body [string] :name
31
+ # @option body [string] :type
32
+ # @option body [boolean] :access_all_engines
33
33
  # @option body :engines
34
- # @option body [Boolean] :write
35
- # @option body [Boolean] :read
34
+ # @option body [boolean] :write
35
+ # @option body [boolean] :read
36
36
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
37
37
  #
38
38
  # @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-create
39
39
  #
40
40
  def create_api_key(arguments = {})
41
- raise ArgumentError, "Required parameter 'body' missing" unless arguments[:body]
41
+ raise ArgumentError, "Required parameter 'body (name,type)' missing" unless arguments[:body]
42
42
 
43
43
  body = arguments.delete(:body) || {}
44
- headers = arguments.delete(:headers) || {}
45
44
 
45
+ headers = arguments.delete(:headers) || {}
46
46
  request(
47
47
  :post,
48
48
  'api/as/v1/credentials/',
@@ -24,9 +24,13 @@ module Elastic
24
24
  # Crawler - Create a crawl request
25
25
  # Creates a request to perform a crawl of a given engine with the Crawler.
26
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
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
+ # @option arguments [Hash] :body
30
+ # @option body [integer] :max_crawl_depth
31
+ # @option body [Array<string>] :domain_allowlist
32
+ # @option body [Array<string>] :seed_urls
33
+ # @option body [Array<string>] :sitemap_urls
30
34
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
31
35
  #
32
36
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-crawl-requests
@@ -35,11 +39,11 @@ module Elastic
35
39
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
36
40
 
37
41
  body = arguments.delete(:body) || {}
38
- headers = arguments.delete(:headers) || {}
39
42
 
43
+ headers = arguments.delete(:headers) || {}
40
44
  request(
41
45
  :post,
42
- "api/as/v0/engines/#{engine_name}/crawler/crawl_requests/",
46
+ "api/as/v1/engines/#{engine_name}/crawler/crawl_requests/",
43
47
  arguments,
44
48
  body,
45
49
  headers
@@ -24,15 +24,16 @@ module Elastic
24
24
  # Crawler - Create a crawl rule
25
25
  # Creates a crawl rule for a given engine and domain
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [String] :domain_id Crawler Domain ID (*Required*)
30
- # @option arguments [Hash] :body (Required: order, policy, rule, pattern)
31
- # @option body [String] :id
32
- # @option body [Integer] :order (*Required)
33
- # @option body [String] :policy (*Required)
34
- # @option body [String] :rule (*Required)
35
- # @option body [String] :pattern (*Required)
30
+ # @option arguments [Hash] :body (Required: order, policy, rule, pattern)
31
+ # @option body [string] :id
32
+ # @option body [integer] :order
33
+ # @option body [string] :policy
34
+ # @option body [string] :rule
35
+ # @option body [string] :pattern
36
+ # @option body [string] :created_at
36
37
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
37
38
  #
38
39
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawl-rules
@@ -40,14 +41,15 @@ module Elastic
40
41
  def create_crawler_crawl_rule(engine_name, arguments = {})
41
42
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
42
43
  raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
44
+ raise ArgumentError, "Required parameter 'body (order,policy,rule,pattern)' missing" unless arguments[:body]
43
45
 
44
- domain_id = arguments[:domain_id]
46
+ domain_id = arguments.delete(:domain_id)
45
47
  body = arguments.delete(:body) || {}
46
- headers = arguments.delete(:headers) || {}
47
48
 
49
+ headers = arguments.delete(:headers) || {}
48
50
  request(
49
51
  :post,
50
- "api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/crawl_rules/",
52
+ "api/as/v1/engines/#{engine_name}/crawler/domains/#{domain_id}/crawl_rules/",
51
53
  arguments,
52
54
  body,
53
55
  headers
@@ -24,13 +24,13 @@ module Elastic
24
24
  # Crawler - Create a crawler domain
25
25
  # Creates a crawler domain configuration for a given engine
26
26
  #
27
- # @param engine_name [String] Name of the engine (*Required*)
28
- # @param arguments [Hash] endpoint arguments
27
+ # @param [String] engine_name Name of the engine (*Required*)
28
+ # @param [Hash] arguments endpoint arguments
29
29
  # @option arguments [Hash] :body
30
- # @option body [String] :name
31
- # @option body [Array] :entry_points
32
- # @option body [Array] :crawl_rules
33
- # @option body [Array] :sitemaps
30
+ # @option body [string] :name
31
+ # @option body [Array<object>] :entry_points
32
+ # @option body [Array<object>] :crawl_rules
33
+ # @option body [Array<object>] :sitemaps
34
34
  # @option arguments [Hash] :headers optional HTTP headers to send with the request
35
35
  #
36
36
  # @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-post-crawler-domains
@@ -39,11 +39,11 @@ module Elastic
39
39
  raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
40
40
 
41
41
  body = arguments.delete(:body) || {}
42
- headers = arguments.delete(:headers) || {}
43
42
 
43
+ headers = arguments.delete(:headers) || {}
44
44
  request(
45
45
  :post,
46
- "api/as/v0/engines/#{engine_name}/crawler/domains/",
46
+ "api/as/v1/engines/#{engine_name}/crawler/domains/",
47
47
  arguments,
48
48
  body,
49
49
  headers