-
Notifications
You must be signed in to change notification settings - Fork 107
ESQL: Update text formats documentation #5054
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks right to me though I don't know this infrastructure well enough to approve it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@nik9000 @ivancea Just an FYI— I've got a PR for a first draft of contribution guidance for the API docs, included in the Elasticsearch quickstart is a way to preview the docs changes. Here's a link to the overview of those new pages: elastic/docs-content#2229 (comment) Let me know if that's helpful in any way, the plan is to merge that guide and then start working with devs to use that to plug some gaps in the new API docs. Will be using that feedback to iterate and improve the guidance over time. :) |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-8.19 8.19
# Navigate to the new working tree
cd .worktrees/backport-8.19
# Create a new branch
git switch --create backport-5054-to-8.19
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a04b8725d5d74c9881b4ed7c579c15c42537791c
# Push it to GitHub
git push --set-upstream origin backport-5054-to-8.19
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-8.19 Then, create a pull request where the |
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-5054-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 a04b8725d5d74c9881b4ed7c579c15c42537791c
# Push it to GitHub
git push --set-upstream origin backport-5054-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0 Then, create a pull request where the |
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872)
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872) Co-authored-by: Iván Cea Fontenla <[email protected]>
Separated the ESQL endpoint formats docs in 3 blocks: Structured, Tabular and Binary (Open to suggestions for the names here). Initially, it was only "Human readable" and "Binary". But CSV, TSV and TXT are different from JSON and YAML, as they don't show all the results, only the query results as a table (For example, no "took" or "is_partial" fields). API specification change: elastic/elasticsearch-specification#5054
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872)
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872)
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872)
Spec docs update for the ESQL `format` parameter. Text formats result in missing metadata in the response body. Main docs change: elastic/docs-content#2307 (cherry picked from commit a04b872)
Spec docs update for the ESQL
format
parameter. Text formats result in missing metadata in the response body.Main docs change: elastic/docs-content#2307