As a devops
I want to request a subset of the resource(s) data
So that I can minimize bandwidth and make my app faster
The ?only query parameter accepts a JSON Pointer as its value. This is the subset of data that is to be returned. If the data is scalar (string, number or boolean) then content-type: text/plain otherwise application/json.
With multiple data being requested, GET /api/resource/123?only=/a&only=/b,data is returned as an object whose key is the JSON pointer.
should work with read and search
should set content-type: text/plain when returning a scalar
should return an object, keyed by the pointer, with multiple only values or resources
should indicate in _metadata that the information is a subset (partial) of the resource.
should not return data from a resource when user is not permitted to view the resource
should return 204 No Content when the pointer has no value.
should decrypt classified information when permitted
This should be implemented as middle-ware so that the data providers to not have to worry about it.
As a devops I want to request a subset of the resource(s) data So that I can minimize bandwidth and make my app faster
The
?onlyquery parameter accepts a JSON Pointer as its value. This is the subset of data that is to be returned. If the data is scalar (string, number or boolean) thencontent-type: text/plainotherwiseapplication/json.With multiple data being requested,
GET /api/resource/123?only=/a&only=/b,data is returned as an object whose key is the JSON pointer.content-type: text/plainwhen returning a scalaronlyvalues or resources_metadatathat the information is a subset (partial) of the resource.This should be implemented as middle-ware so that the data providers to not have to worry about it.