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

Add canceled status to Task statuses in all SDK's README #245

Closed
alallema opened this issue Feb 22, 2023 · 5 comments
Closed

Add canceled status to Task statuses in all SDK's README #245

alallema opened this issue Feb 22, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation ready to implement

Comments

@alallema
Copy link
Contributor

Description
Currently, the different statuses are listed in the readme after an example.
In v0.30 the canceled status was added to the API return Task statuses but was not updated in the readme:

With the uid, you can check the status (enqueued, processing, succeeded or failed) of your documents addition using the task.

It should be updated.

@alallema alallema changed the title Add canceled status to Task statuses in all SDK readme Add canceled status to Task statuses in all SDK's README Feb 22, 2023
@brunoocasali brunoocasali added documentation Improvements or additions to documentation ready to implement and removed ready to implement labels Feb 22, 2023
@brunoocasali
Copy link
Member

Raising a question:
Is it valid to duplicate the role of the documentation in this kind of code? If we only keep the link, we don't need to worry about it again...

In any case I agree with the change @alallema.

@bidoubiwa
Copy link
Contributor

Maybe we could change this:

Tasks such as document addition always return a unique identifier. You can use this identifier taskUid to check the status (enqueued, processing, succeeded or failed) of a task.

To this:

Tasks such as document addition always return a unique identifier. You can use this identifier `taskUid` to check the status of a [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).

So that we avoid having to maintain that sort of documentation in the readme's.

What do you think?

@alallema
Copy link
Contributor Author

alallema commented Mar 2, 2023

So that we avoid having to maintain that sort of documentation in the readme's.

Yes I agree it's also good not to put all the possible status, but maybe we should add something like

Tasks such as document addition always return a unique identifier. You can use this identifier `taskUid` to check the status of a [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task) and see if it has been processed.

To be sure the user know that the task is asynchrone.

@bidoubiwa
Copy link
Contributor

I like that!

meili-bors bot added a commit to meilisearch/meilisearch-js that referenced this issue Aug 14, 2023
1564: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-php that referenced this issue Aug 14, 2023
565: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-go that referenced this issue Aug 14, 2023
472: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-python that referenced this issue Aug 14, 2023
834: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-ruby that referenced this issue Aug 14, 2023
465: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-dotnet that referenced this issue Aug 14, 2023
464: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
@brunoocasali
Copy link
Member

Done!

meili-bors bot added a commit to meilisearch/meilisearch-dart that referenced this issue Aug 14, 2023
345: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-java that referenced this issue Aug 14, 2023
639: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-swift that referenced this issue Aug 14, 2023
403: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
meili-bors bot added a commit to meilisearch/meilisearch-rust that referenced this issue Aug 14, 2023
505: Add `canceled` task status to README.md r=brunoocasali a=meili-bot

_This PR is auto-generated._
Update the README according to [issue](meilisearch/integration-guides#245).


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready to implement
Projects
None yet
Development

No branches or pull requests

3 participants