Eloquent API Resource with loaded relation

[jrglaber]

I used the whenLoaded for load the relation in Resources, but the apidoc:generate don't load the relations and don't load the resource correctly:

return [ 'id' => $this->id, 'contacts' => $this->whenLoaded('contacts', function(){ return ContactResource::collection($this->contacts); }), ];

[shalvah]

What strategy are you using? The Api Resource strategy does not execute your code, and so does not know of those conditions.

[shalvah]

We could potentially add a with parameter to the annotation. Something like @apiResource App\User with=contacts,pets to indicate that the model should be loaded with those relations. However, depending on how the model instance is generated (see second paragraph in https://laravel-apidoc-generator.readthedocs.io/en/latest/documenting.html#apiresource-apiresourcecollection-and-apiresourcemodel), this may not be guaranteed. It's not a priority now, though. PRs welcome.

[jrglaber]

awaiting, thanks

[shalvah]

This is now supported in Scribe 🙂.