Browse Source

Added buffer to vector tile REST API docs (#85460)

Craig Taverner 3 years ago
parent
commit
0b84eb1a53
1 changed files with 9 additions and 0 deletions
  1. 9 0
      docs/reference/search/search-vector-tile-api.asciidoc

+ 9 - 0
docs/reference/search/search-vector-tile-api.asciidoc

@@ -202,6 +202,13 @@ larger than the vector tile.
 square with equal sides. Defaults to `4096`.
 // end::extent-param[]
 
+// tag::buffer-param[]
+`buffer`::
+(Optional, integer) Size, in pixels, of a clipping buffer outside the tile.
+This allows renderers to avoid outline artifacts from geometries that extend past the extent of the tile.
+Defaults to `5`.
+// end::buffer-param[]
+
 // tag::grid-agg[]
 `grid_agg`::
 (Optional, string) Aggregation used to create a grid for the `<field>`.
@@ -375,6 +382,8 @@ include::search-vector-tile-api.asciidoc[tag=exact-bounds]
 
 include::search-vector-tile-api.asciidoc[tag=extent-param]
 
+include::search-vector-tile-api.asciidoc[tag=buffer-param]
+
 `fields`::
 (Optional, array of strings and objects) Fields to return in the `hits` layer.
 Supports wildcards (`*`).