Skip to content

Reusable requests functionality #9230

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

Merged
merged 121 commits into from
May 20, 2025
Merged

Conversation

Marishka17
Copy link
Contributor

@Marishka17 Marishka17 commented Mar 19, 2025

Motivation and context

API changes:

  • POST /api/consensus/merges?rq_id=rq_id returns 410 status code, this endpoint no longer supports process status checking
  • GET /api/projects/id/dataset?action=import_status returns 410 status code, this endpoint no longer supports process status checking
  • POST /api/projects/backup?rq_id=rq_id returns 410 status code, this endpoint no longer supports process status checking
  • POST /api/tasks/backup?rq_id=rq_id returns 410 status code, this endpoint no longer supports process status checking
  • PUT /api/tasks/id/annotations?rq_id=rq_id&format=format returns 410 status code, this endpoint no longer supports process status checking
  • PUT /api/jobs/id/annotations?rq_id=rq_id&format=format returns 410 status code, this endpoint no longer supports process status checking
  • GET /api/events is deprecated in favor of the following API:
    • [new] POST /api/events/export (returns 202 with Request ID)
    • GET /api/requests/rq_id
    • [new] GET /api/events/download?rq_id=rq_id (private endpoint, should be used only as result_url)
  • POST /api/quality/reports/rq_id=rq_id is deprecated in favor of GET /api/requests/rq_id

Architecture visible changes:

  • Cache files containing events (created after using the API to export events as a file) are stored in /data/cache/export/ instead of /data/tmp/. The _clear_export_cache function is deleted, since cache files are deleted one day after creation (by default) by the cleanup_export_cache_directory cron job.

API backward-incompatible changes:
- POST /api/projects|tasks|jobs/id/annotations|dataset|backup API accepts unified body: {"file": ...} when file is uploaded now via TUS.

SDK backward-incompatible changes:

  • [requests_api.list] action/target/subresource filters now have string type
  • Several types were removed: AnnotationFileRequest/ProjectFileRequest/DatasetFileRequest/TaskFileRequest; DatasetWriteRequest/BackupWriteRequest/TaskAnnotationsWriteRequest; JobAnnotationsUpdateRequest/TaskAnnotationsUpdateRequest
  • RqId renamed to RequestId

List with all possible request types:

  • Export requests:
    • action=export, target=project|task|job, target_id=target_id, subresource=dataset|annotations, format=format, user_id=uid
    • action=export, target=project|task, target_id=target_id, subresource=backup, user_id=uid
    • action=export, target=events, id=uuid, user_id=uid
  • Import requests:
    • action=import, target=task|job, target_id=target_id, subresource=annotations
    • action=import, target=project, target_id=target_id, subresource=dataset
    • action=import, target=project|task, id=uuid, subresource=backup
  • Creation requests:
    • action=create, target=task, target_id=target_id
  • Auto annotation requests:
    • action=autoannotate, target=task, target_id=target_id
  • Merging requests:
    • action=merge, target=task|job, target_id=target_id
  • Calculation requests:
    • action=calculate, target=task, target_id=target_id, subresource=quality

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@cvat-ai cvat-ai deleted a comment from github-actions bot Apr 29, 2025
@Marishka17 Marishka17 requested a review from nmanovic as a code owner April 29, 2025 14:53
@Marishka17 Marishka17 force-pushed the mk/reusable_requests_functionality branch from af8a072 to 678ec1b Compare April 29, 2025 14:58
@Marishka17 Marishka17 changed the title [do not merge] Reusable requests functionality Reusable requests functionality May 12, 2025
@Marishka17 Marishka17 force-pushed the mk/reusable_requests_functionality branch from 001ed8c to 9c5602f Compare May 13, 2025 10:49
Copy link

@Marishka17 Marishka17 merged commit 55652dd into develop May 20, 2025
34 checks passed
@Marishka17 Marishka17 deleted the mk/reusable_requests_functionality branch May 20, 2025 16:01
@cvat-bot cvat-bot bot mentioned this pull request May 27, 2025
paveltovchigrechko added a commit that referenced this pull request May 30, 2025
<!-- Raise an issue to propose your change
(https://github.com/cvat-ai/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution guide](https://docs.cvat.ai/docs/contributing/).
-->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->
Documentation updates for #9230.

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [ ] I have created a changelog fragment <!-- see top comment in
CHANGELOG.md -->
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))

### License

- [ ] I submit _my code changes_ under the same [MIT License](
https://github.com/cvat-ai/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.

---------

Co-authored-by: Marishka17 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants