Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add error examples to the Bulk API REST docs #55237

Closed
jrodewig opened this issue Apr 15, 2020 · 2 comments · Fixed by #55412
Closed

[DOCS] Add error examples to the Bulk API REST docs #55237

jrodewig opened this issue Apr 15, 2020 · 2 comments · Fixed by #55412
Assignees
@jrodewig
Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes

Comments

@jrodewig
Copy link
Contributor

jrodewig commented Apr 15, 2020 •
edited
Loading

The Java HLRC docs include some examples of bulk operations with failure.

We should include example responses with an errors flag of true that contain the error type and reason in the REST Bulk API docs. We should also document the error type and reason fields.

Relates to #55043.
@jrodewig jrodewig added >docs General docs changes :Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. labels Apr 15, 2020
@jrodewig jrodewig self-assigned this Apr 15, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/CRUD)

This was referenced Apr 15, 2020
Closed
Merged
Merged
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Add bulk API example with failures (#55412)
43b3599 
Adds an example for bulk API requests that include failures.
Also documents guidance on use the `filter_path` parameter
to narrow the bulk API response for errors.

Closes #55237
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Add bulk API example with failures (#55412)
777ffd5 
Adds an example for bulk API requests that include failures.
Also documents guidance on use the `filter_path` parameter
to narrow the bulk API response for errors.

Closes #55237
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Add bulk API example with failures (#55412)
6212f74 
Adds an example for bulk API requests that include failures.
Also documents guidance on use the `filter_path` parameter
to narrow the bulk API response for errors.

Closes #55237
jrodewig added a commit that referenced this issue Apr 21, 2020
@jrodewig
[DOCS] Add bulk API example with failures (#55412)
f31d3a2 
Adds an example for bulk API requests that include failures.
Also documents guidance on use the `filter_path` parameter
to narrow the bulk API response for errors.

Closes #55237
jrodewig added a commit that referenced this issue Apr 22, 2020
@jrodewig
[DOCS] Document missing bulk API response parameters (#55414)
fb217d9 
Documents several parameters missing from the bulk API's response body docs.
Also moves several response-related chunks of text to the response
body section.

Relates to #55237
jrodewig added a commit that referenced this issue Apr 22, 2020
@jrodewig
[DOCS] Document missing bulk API response parameters (#55414)
414f9c9 
Documents several parameters missing from the bulk API's response body
docs. Also moves several response-related chunks of text to the response
body section.

Relates to #55237
jrodewig added a commit that referenced this issue Apr 22, 2020
@jrodewig
[DOCS] Document missing bulk API response parameters (#55414)
4f4f628 
Documents several parameters missing from the bulk API's response body
docs. Also moves several response-related chunks of text to the response
body section.

Relates to #55237
jrodewig added a commit that referenced this issue Apr 22, 2020
@jrodewig
[DOCS] Document missing bulk API response parameters (#55414)
c3987ae 
Documents several parameters missing from the bulk API's response body
docs. Also moves several response-related chunks of text to the response
body section.

Relates to #55237
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jrodewig jrodewig

Labels
:Distributed Indexing/CRUD A catch all label for issues around indexing, updating and getting a doc by id. Not search. >docs General docs changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[DOCS] Add bulk API example with failures
2 participants
@elasticmachine @jrodewig