Implemented sparse fieldsets support on the backend #1152 #1715
Conversation
Eric-Wasson
commented
Oct 27, 2025
Eric-Wasson
commented
Agents overview page with sparse fieldsets applied
Tasks overview page with sparse fieldsets applied. A bit more data gets returned than requested. This is because of the aggregatedData function, which doesn't skip the non-included data yet. There was a todo-comment about that already before my commit (now on line 594 in AbstractBaseAPI.class.php). That's something that I'll improve in the future.
Task overview page with sparse fieldsets applied for 3 different types of data: task, hashlist and hashType
Eric-Wasson
added
the
enhancement
Eric-Wasson
changed the title
| } | ||
|
|
||
| // If sparse fieldsets (https://jsonapi.org/format/#fetching-sparse-fieldsets) is used, return only the requested data | ||
| if (is_array($sparseFieldsets)) { |
There was a problem hiding this comment.
Try to put the three if statements into a single if statement
src/inc/apiv2/model/tasks.routes.php
Outdated
| if ($keyspaceProgress >= $keyspace && $keyspaceProgress > 0) { | ||
| $status = 3; | ||
|
|
||
| if(is_array($sparseFieldsets) && array_key_exists('task', $sparseFieldsets) && in_array("searched", $sparseFieldsets['task']) ) { |
There was a problem hiding this comment.
the first part of the check: " if(is_array($sparseFieldsets) && array_key_exists('task', $sparseFieldsets)". is now done twice, I would say do that part as on outer if statement, and then afterwards just check individually for "searched" and "status"
src/inc/apiv2/model/tasks.routes.php
Outdated
| elseif (count($activeAgents) > 0) { | ||
| $status = 1; | ||
|
|
||
| if(is_array($sparseFieldsets) && array_key_exists('task', $sparseFieldsets) && in_array("searched", $sparseFieldsets['task']) ) { |
There was a problem hiding this comment.
I think "searched" here, should be "status".
|
With this code, will it be possible to simply return the entire object and only specify in the sparse fieldset that you also want some extra agregated data? If not I would suggest to use a different query structure for the aggregated data so that you can add aggregated data with just a few extra additions to your query |
|
Thanks for the feedback! I've fixed the things you mentioned and for the aggregated data it's now possible to query it separately: 
Task overview without sparse fieldsets but with selected aggregated data.
Task overview with sparse fieldsets and selected aggregated data.
Task overview with sparse fieldsets and without specifying aggregated data fields.
|
