Skip to content

Commit c911475

Browse files
charlotte-hoblikpquentin
authored andcommitted
Remove examples from search vector tile API (#4616)
* Remove examples from search vector tile API * Fix styling --------- Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit b60252e)
1 parent 4cd7a7d commit c911475

File tree

1 file changed

+2
-48
lines changed

1 file changed

+2
-48
lines changed

specification/_global/search_mvt/SearchMvtRequest.ts

Lines changed: 2 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -44,54 +44,6 @@ import { ZoomLevel } from './_types/ZoomLevel'
4444
* * Optionally, a `geo_bounds` aggregation on the `<field>`. The search only includes this aggregation if the `exact_bounds` parameter is `true`.
4545
* * 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.
4646
*
47-
* 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
48-
*
49-
* ```
50-
* GET my-index/_search
51-
* {
52-
* "size": 10000,
53-
* "query": {
54-
* "geo_bounding_box": {
55-
* "my-geo-field": {
56-
* "top_left": {
57-
* "lat": -40.979898069620134,
58-
* "lon": -45
59-
* },
60-
* "bottom_right": {
61-
* "lat": -66.51326044311186,
62-
* "lon": 0
63-
* }
64-
* }
65-
* }
66-
* },
67-
* "aggregations": {
68-
* "grid": {
69-
* "geotile_grid": {
70-
* "field": "my-geo-field",
71-
* "precision": 11,
72-
* "size": 65536,
73-
* "bounds": {
74-
* "top_left": {
75-
* "lat": -40.979898069620134,
76-
* "lon": -45
77-
* },
78-
* "bottom_right": {
79-
* "lat": -66.51326044311186,
80-
* "lon": 0
81-
* }
82-
* }
83-
* }
84-
* },
85-
* "bounds": {
86-
* "geo_bounds": {
87-
* "field": "my-geo-field",
88-
* "wrap_longitude": false
89-
* }
90-
* }
91-
* }
92-
* }
93-
* ```
94-
*
9547
* The API returns results as a binary Mapbox vector tile.
9648
* Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers:
9749
*
@@ -166,6 +118,8 @@ import { ZoomLevel } from './_types/ZoomLevel'
166118
* Some cells may intersect more than one vector tile.
167119
* 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.
168120
* Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.
121+
*
122+
* Learn how to use the vector tile search API with practical examples in the [Vector tile search examples](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search) guide.
169123
* @rest_spec_name search_mvt
170124
* @availability stack since=7.15.0 stability=stable
171125
* @availability serverless stability=stable visibility=public

0 commit comments

Comments
 (0)