API Documentation missing about sarala

[milroyfraser]

Hi @Garanaw,

According to JSON:API spec in api response data.relationships should only contain reference objects. And data belongs to relationships should go inside included

https://laravel-news.com/json-api-introduction

Best,

[Garanaw]

@milroyfraser That's great, finally I got the right format. Thanks! Might I suggest to add this page as well as other links I've seen in other issues to a wiki page as a reference? That'd save us time trying to find some documentation, and some of the time you spend answering this kind of questions too.
Again, thank you.

P.S. Issue ready to be closed if you agree

[Garanaw]

@milroyfraser Again struggling with relationships, collections this time. I followed the exact format shown in the link above (literally copy/paste the example), yet the formatter complains about "data is undefined". It works fine with a single item in the relationships/included fields ( 'included' => ['includedItem' => new Resource($item)] ).

Any specific format for this use case?

Thank you

[aidan-casey]

Hi @Garanaw, I cannot speak for the author, but I think this package assumes a familiarity with the JSON:API specification, so that kind of documentation doesn't really belong here.

That said, so you aren't repeating work that's already been done, I highly recommend you check out CloudCreativity's Laravel-JSON-API package for Laravel. It is an extensive package that implements the best practices descriped by that JSON:API spec.