You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,7 @@ module Actions
31
31
# A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*)
32
32
# @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
33
33
# If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns.
34
+
# @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`.
34
35
# @option arguments [Time] :keep_alive The period for which the query and its results are stored in the cluster.
35
36
# When this period expires, the query and its results are deleted, even if the query is still ongoing.
36
37
# @option arguments [Time] :wait_for_completion_timeout The period to wait for the request to finish.
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb
+1-48Lines changed: 1 addition & 48 deletions
Original file line number
Diff line number
Diff line change
@@ -30,54 +30,6 @@ module Actions
30
30
# * A `geotile_grid` or `geohex_grid` aggregation on the `<field>`. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `<zoom>/<x>/<y>` tile as a bounding box.
31
31
# * Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.
32
32
# * If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label.
33
-
# For example, Elasticsearch may translate a vector tile search API request with a `grid_agg` argument of `geotile` and an `exact_bounds` argument of `true` into the following search
34
-
#
35
-
# ```
36
-
# GET my-index/_search
37
-
# {
38
-
# "size": 10000,
39
-
# "query": {
40
-
# "geo_bounding_box": {
41
-
# "my-geo-field": {
42
-
# "top_left": {
43
-
# "lat": -40.979898069620134,
44
-
# "lon": -45
45
-
# },
46
-
# "bottom_right": {
47
-
# "lat": -66.51326044311186,
48
-
# "lon": 0
49
-
# }
50
-
# }
51
-
# }
52
-
# },
53
-
# "aggregations": {
54
-
# "grid": {
55
-
# "geotile_grid": {
56
-
# "field": "my-geo-field",
57
-
# "precision": 11,
58
-
# "size": 65536,
59
-
# "bounds": {
60
-
# "top_left": {
61
-
# "lat": -40.979898069620134,
62
-
# "lon": -45
63
-
# },
64
-
# "bottom_right": {
65
-
# "lat": -66.51326044311186,
66
-
# "lon": 0
67
-
# }
68
-
# }
69
-
# }
70
-
# },
71
-
# "bounds": {
72
-
# "geo_bounds": {
73
-
# "field": "my-geo-field",
74
-
# "wrap_longitude": false
75
-
# }
76
-
# }
77
-
# }
78
-
# }
79
-
# ```
80
-
#
81
33
# The API returns results as a binary Mapbox vector tile.
82
34
# Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:
83
35
# * A `hits` layer containing a feature for each `<field>` value matching the `geo_bounding_box` query.
@@ -142,6 +94,7 @@ module Actions
142
94
# Some cells may intersect more than one vector tile.
143
95
# To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level.
144
96
# Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
97
+
# Learn how to use the vector tile search API with practical examples in the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search Vector tile search examples} guide.
145
98
#
146
99
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, or aliases to search (*Required*)
147
100
# @option arguments [String] :field Field containing geospatial data to return (*Required*)
Copy file name to clipboardExpand all lines: elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -28,6 +28,7 @@ module Actions
28
28
# To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.
29
29
# If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
30
30
# If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
31
+
# Refer to the linked documentation for examples of how to find API keys:
31
32
#
32
33
# @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.
33
34
# An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).
0 commit comments