czim / laravel-jsonapi Goto Github PK

Example:

Currently this is how you map include relations to model relations:

	/**
	 * @var array
	 */
	protected $availableIncludes = [
		'bookings',
		'user-profile',
		'user-addresses',
	];

	/**
	 * @var array
	 */
	protected $includeRelations = [
		'user-profile' => 'userProfile',
		'user-addresses' => 'userAddresses',
	];

The available includes are configured, and the mapping is separately configured in its own property. This is clunky and requires a new property for every aspect of an include.

It would be nicer if this would have the following format instead:

    /**
     * @var array
     */
    protected $includes = [
        'bookings',
        'user-profile' => [
            'relation' => 'userProfile',
        ],
        'user-addresses' => [
            'relation' => 'userAddresses',
        ],
    ];

Or something along these lines. Adding new aspects would be easy.

This should be applied across the board, for attributes, filtering, etc.

This will of course be a huge breaking change.

A resource object MAY contain an attributes top-level member.

Empty attributes should be valid.

{
  "data": {
    "type": "examples",
    "attributes": {
    }
  }
}

Source: https://jsonapi.org/format/#document-resource-objects

The transformer logic should allow including this with sensible business logic.

{"meta": {"count": 13}}

When using Custom Polymorphic Types the model cannot be resolved for polymorphic relationships.

I would suggest checking the MorphMap here. But I'm sure there are better places..

count(): Parameter must be an array or an object that implements Countable