Sparse Fieldsets

[olragon]

https://jsonapi.org/format/#fetching-sparse-fieldsets

A client MAY request that an endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] parameter.

Can we implement this usage pattern?

[alexzarbn]

Hi @olragon,

It is currently not supported and there is no scheduled milestone for this feature yet. Leaving the issue open to see, if more developers would need that functionality.

[glennjacobs]

This would be really handy to have. Would you be open to a PR?

[alexzarbn]

Hi @glennjacobs,

Sure, PRs are always welcome ~

[rossity]

@alexzarbn

Just want to also add that this feature would be immensely useful, especially if you add support in the JS library. Would cut down a lot on having to write different controllers/resources/or other logic that removes certain fields from a search.

[emeGuan]

Maybe someone might find it interesting.
https://github.com/emeGuan/laravel-resources
It is not a substitute for this fantastic Laravel Orion library, far from it. But it can be useful for someone who wants to build their API using https://laravel.com/docs/10.x/eloquent-resources
Regards.

[rossity]

@alexzarbn @olragon

I created a simple implementation of this.

#226
tailflow/laravel-orion-ts#36

Edit: updated them to use sparse fieldsets.

[cirrusmostar]

This should be mentioned in the RADME along with other essential functionality that is not available in this package.