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.

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

Task Management Documentation - update example on taskID:1 and task_id:1(in update-by-query) #28314

Closed
matt-isett opened this issue Jan 19, 2018 · 4 comments
Assignees
Labels
:Distributed Coordination/Task Management Issues for anything around the Tasks API - both persistent and node level. >docs General docs changes

Comments

@matt-isett
Copy link

Elasticsearch version:
5.X - 6.X

Description:
Document update needed change from taskid:1 to Nodeid:1 or just taskID which is Nodeid:taskid.

While reading update-by-query; the docs reference taskid as how to get the task information

GET /_tasks/taskId:1

but does not call out what taskId is. It is not the taskID but the Node ID followed by a colon.

When you follow the link over to the main task management docs; it also references a task id but in a different format and seems to say the task id, but again it is the node id.

GET _tasks/task_id:1 
@matt-isett matt-isett added the >docs General docs changes label Jan 19, 2018
@colings86 colings86 added the :Distributed Coordination/Task Management Issues for anything around the Tasks API - both persistent and node level. label Apr 24, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

@bleskes
Copy link
Contributor

bleskes commented May 3, 2018

@nik9000 @imotov I know this was a conscious choice from previous discussions. Care to comment?

@imotov
Copy link
Contributor

imotov commented May 3, 2018

I think it should be just taskId as it was in the original version, because the entire thing is essentially a taskId. In other words, it should be: GET /_tasks/taskId. At the moment, the taskId is indeed represented as nodeId:Number, but this might change in the future releases, and we don't want to make it a documented "feature" that users rely on, only to break it in the future releases.

However, I would like to hear @nik9000's opinion since it looks like he changed it from taskId to taskId:1 two years ago, and I am not sure I fully understand reasons behind this change.

@nik9000
Copy link
Member

nik9000 commented May 7, 2018

I think it should be just taskId as it was in the original version, because the entire thing is essentially a taskId.

+1. I changed it in the past so it'd parse when I converted the example to // CONSOLE so we'd execute it. We have better tools now, so I can revert it so it makes sense again.

@nik9000 nik9000 self-assigned this May 7, 2018
nik9000 added a commit to nik9000/elasticsearch that referenced this issue May 7, 2018
We had been using `task_id:1` or `taskId:1` because it is parses as a
valid task identifier but the `:1` part is confusing. This replaces
those examples with `task_id` which matches the response from the list
tasks API.

Closes elastic#28314
nik9000 added a commit that referenced this issue May 8, 2018
We had been using `task_id:1` or `taskId:1` because it is parses as a
valid task identifier but the `:1` part is confusing. This replaces
those examples with `task_id` which matches the response from the list
tasks API.

Closes #28314
nik9000 added a commit that referenced this issue May 8, 2018
We had been using `task_id:1` or `taskId:1` because it is parses as a
valid task identifier but the `:1` part is confusing. This replaces
those examples with `task_id` which matches the response from the list
tasks API.

Closes #28314
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Task Management Issues for anything around the Tasks API - both persistent and node level. >docs General docs changes
Projects
None yet
Development

No branches or pull requests

6 participants