Bug #18122
closed
Support 'select' on 'get', 'update', and 'delete' calls to limit what fields are returned in update response
Added by Peter Amstutz over 3 years ago.
Updated about 3 years ago.
Release relationship:
Auto
Description
'get', 'update' and 'delete' calls respond with the entire record. Sometimes this is undesirable, such as collections with very large manifest text. The API should support using 'select' to choose which fields are returned by the response.
"make sure you start with a test, but this might already work"
needs to be added to the discovery document.
check that selecting fields ensures the fields are not loaded from the database.
- Description updated (diff)
- Subject changed from Support 'select' on update calls to limit what fields are returned in update response to Support 'select' on 'get', 'update', and 'delete' calls to limit what fields are returned in update response
For the 'get' case, would it be useful to have a 'deselect' param so that we don't need to update clients (e.g., wb2) when new fields are added to collections while avoiding getting the manifest_text
included in the response?
- Description updated (diff)
- Target version set to 2021-09-29 sprint
- Description updated (diff)
- Assigned To set to Tom Clegg
- Status changed from New to In Progress
Here're my comments/questions:
- In file
services/api/app/controllers/application_controller.rb
: In the _requires_parameters
methods, should descriptions be added for the automatic cli help?
- Word repetition in file
doc/api/methods.html.textile.liquid:L87
: "...whose whose..."
- Do you think it would be helpful to document the particular behavior when requesting a collection by PDH? (i.e., we can use
select
to "deselect" manifest_text
)
Lucas Di Pentima wrote:
- In file
services/api/app/controllers/application_controller.rb
: In the _requires_parameters
methods, should descriptions be added for the automatic cli help?
Good point, added
- Word repetition in file
doc/api/methods.html.textile.liquid:L87
: "...whose whose..."
Fixed, thanks
- Do you think it would be helpful to document the particular behavior when requesting a collection by PDH? (i.e., we can use
select
to "deselect" manifest_text
)
Updated the relevant part of the api/methods/collections page -- is this better?
18122-select-param @ bc146037e1aa617739c0a3859727066c9304829a -- developer-run-tests: #2696
- Status changed from In Progress to Resolved
Applied in changeset arvados-private:commit:arvados|c8bf4dc1eef2a73b4b01501eabdc922e2a27a276.
- Related to Feature #18215: Use 'select' on collection updates to avoid returning manifest_text added
Also available in: Atom
PDF