Skip to content

Commit

Permalink
[DOCS] Document _mvt API (#75384) (#76191)
Browse files Browse the repository at this point in the history
* [DOCS] Document `_mvt` API

Documents the `_mvt` API endpoint added with #73872.

Relates to #75242.

* Reword

* Rename API

* Fix doc.url in JSON spec

* Reword

* Reword

* Add content type to JSON spec

* Edits

* Fix typo

* Reword

* Update docs after meeting

* Fix typos

* Fix `size` default

* Updates for #75522

* Fixes

* Clean up JSON spec

* Fix extent tag

* [DOCS] Add `<field>` constraints

* Minor clarification

* Update for #75697

* Reword

* Update for #75621

* Reword default sort

* Update for #75367

* Remove unneeded whitespace

* Add experimental admon and if flags

* [DOCS] Remove ifdefs

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
  • Loading branch information
3 people authored Aug 5, 2021
1 parent 0cac148 commit 574c33e
Show file tree
Hide file tree
Showing 6 changed files with 890 additions and 33 deletions.
17 changes: 1 addition & 16 deletions docs/reference/eql/eql-search-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -207,22 +207,7 @@ You can specify items in the array as a string or object.
.Properties of `fields` objects
[%collapsible%open]
====
`field`::
(Required, string)
Wildcard pattern. The request returns values for field names matching this
pattern.
`format`::
(Optional, string)
Format in which the values are returned.
+
<<date,`date`>> and <<date_nanos, `date_nanos`>> fields accept a
<<mapping-date-format,date format>>. <<spatial_datatypes, Spatial fields>>
accept either `geojson` for http://www.geojson.org[GeoJSON] (the default) or
`wkt` for {wikipedia}/Well-known_text_representation_of_geometry[Well Known
Text].
+
For other field data types, this parameter is not supported.
include::{es-repo-dir}/search/search.asciidoc[tag=fields-api-props]
====

`filter`::
Expand Down
6 changes: 6 additions & 0 deletions docs/reference/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ exception of the <<search-explain,explain API>>.
* <<multi-search-template>>
* <<render-search-template-api>>

[discrete]
[[geo-search-apis]]
=== Geospatial search
* <<search-vector-tile-api>>

include::search/search.asciidoc[]

Expand Down Expand Up @@ -75,3 +79,5 @@ include::search/profile.asciidoc[]
include::search/field-caps.asciidoc[]

include::search/rank-eval.asciidoc[]

include::search/search-vector-tile-api.asciidoc[]
Loading

0 comments on commit 574c33e

Please sign in to comment.