[DOCS] Document _mvt API
#75384
Merged
[DOCS] Document _mvt API
#75384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrodewig
commented
Jul 15, 2021
jrodewig
commented
Jul 15, 2021
rest-api-spec/src/main/resources/rest-api-spec/api/vector_tile.json
Outdated
Show resolved
Hide resolved
jrodewig
commented
Jul 15, 2021
jrodewig
commented
Jul 15, 2021
|
Pinging @elastic/clients-team (Team:Clients) |
jrodewig
added
:Analytics/Geo
elasticmachine
added
Team:Analytics
|
Pinging @elastic/es-analytics-geo (Team:Analytics) |
|
Pinging @elastic/es-docs (Team:Docs) |
delvedor
reviewed
Jul 15, 2021
|
I have a quick look and it is looking great. I would like to wait until next week to give further feedback as we are going to discuss about some rough edges. Hope that's ok. |
|
Sounds good. Thanks @iverase! |
jrodewig
commented
Jul 28, 2021
Comment on lines
+52
to
+53
| Using object notation, you can pass a <<search-api-fields,`format`>> argument to | ||
| customize the format of returned date or geospatial values. |
There was a problem hiding this comment.
This removes some duplicated copy for the fields API/parameter and replaces it with an xref. This should make it easier to maintain the docs if we add/remove more format options in the future.
|
@elasticmachine update branch |
jrodewig
added
auto-backport-and-merge
and removed
auto-backport
|
@elasticmachine update branch |
mark-vieira
added
auto-backport
iverase
approved these changes
Aug 5, 2021
There was a problem hiding this comment.
LGTM! Thank you so much @jrodewig, documentation is looking great and I think we can. already push this version forward. Note that we are in the process to remove the feature flag so might want to do the same before pushing it.
|
@elasticmachine run elasticsearch-ci/bwc |
|
@elasticmachine update branch |
|
@elasticmachine update branch |
jrodewig
added
the
auto-merge-without-approval
elasticsearchmachine
pushed a commit
to elasticsearchmachine/elasticsearch
that referenced
this pull request
Aug 5, 2021
* [DOCS] Document `_mvt` API Documents the `_mvt` API endpoint added with elastic#73872. Relates to elastic#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 elastic#75522 * Fixes * Clean up JSON spec * Fix extent tag * [DOCS] Add `<field>` constraints * Minor clarification * Update for elastic#75697 * Reword * Update for elastic#75621 * Reword default sort * Update for elastic#75367 * Remove unneeded whitespace * Add experimental admon and if flags * [DOCS] Remove ifdefs Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
💚 Backport successful
|
elasticsearchmachine
added a commit
that referenced
this pull request
Aug 5, 2021
* [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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents the
_mvtAPI endpoint added with #73872 and #75522.Closes #75242.
Preview
https://elasticsearch_75384.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/search-vector-tile-api.html