Skip to content

Tasks Endpoint

Pre-release
Pre-release
Compare
Choose a tag to compare
@djanderson djanderson released this 06 Jun 06:22
· 999 commits to master since this release
3eba31e

The largest change in the release is that the /acquisitions endpoint, which holds data produced when the scheduler runs a task that saves data in the database, and the /results endpoint, which was created later to give some status information about each task run, have been merged into a new /tasks endpoint.

We also took this opportunity to relocate the "task queue", which provides a snapshot of upcoming tasks as seen by the scheduler, from the /status endpoint into /tasks.

/tasks/upcoming now shows the tasks queue. It now shows at most settings.MAX_TASK_QUEUE upcoming tasks.
/tasks/completed gives overview information about the number of results available for reach schedule entry that you have permissions to view, and also provides a link to download a multi-recording archive of all available data for that schedule entry.
/tasks/completed/{schedule_entry_name} lists each task result and "metadata" and SigMF "archive" links under the new data key, if available.
/tasks/completed/{schedule_entry_name}/{task_id} shows the detail view for a single task result

Multi-recording SigMF archive are now supported, which means actions can produce them. The "stepped frequency" style actions now produce multi-recording archive to allow a different sample rate at each center frequency.

Other changes:

  • sensor definition can be loaded from a yaml file
  • actions can be defined in yaml as well (see /configs/README.md)
  • superuser (admin) account can be generated automatically from environment variables
  • django-debug-toolbar is enabled when DEBUG=true
  • object's url field name changed from "url" to "self" for consistency with RFC 42867
  • Task object (displayed in task queue at /tasks/upcoming) "time" field changed from epoch timestamp to datetime string to better align with rest of API
  • setup automatic code formatters using pre-commit. See the DEVELOPING.md file fore notes
  • Fixed many bugs, upgraded and added tests, updates dependency version, and much more...