Reusable requests functionality

[Marishka17]

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.

[sonarqubecloud]

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
1.9% Duplication on New Code

See analysis details on SonarQube Cloud