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

v1.12: New /batches API route #3061

Open
5 tasks done
guimachiavelli opened this issue Dec 3, 2024 · 0 comments · May be fixed by #3072
Open
5 tasks done

v1.12: New /batches API route #3061

guimachiavelli opened this issue Dec 3, 2024 · 0 comments · May be fixed by #3072
Milestone

Comments

@guimachiavelli
Copy link
Member

guimachiavelli commented Dec 3, 2024

v1.12 introduces the /batches route. Its main goal is to give more information on how tasks are being processed and helps diagnose in case of failure.

  • new GET /batches
    • supports a several parameters
    • need defaults from #person/tamo
    • returns a list of batchObjects
  • new GET /batches/:uid
    • does not accept query/body parameters
    • returns a single batchObject
  • updated /tasks and /tasks/:uid
    • new parameter batchUids, returns all tasks whose batchUid match the specified value
  • updated task object
    • includes new field batchUid
  • new error: InvalidBatchUids for /batch and /batch/:uid

Tasks

  • Create new reference/api/batches.mdx
  • Update reference/api/tasks.mdx
  • Update learn/async/filtering_tasks.mdx -> probably add batches to title and/or a box saying everything there is valid for batches
  • Update learn/async/paginating_tasks.mdx -> same as above
  • Update learn/async/asynchronous_operations.mdx -> mention batches

References

@guimachiavelli guimachiavelli added this to the v1.12 milestone Dec 3, 2024
@guimachiavelli guimachiavelli linked a pull request Dec 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant