Selecting fields for included relations

[JaviLerma]

Greetings from Argentina!
The Official docs says:

QueryBuilder::for(Post::class)  
    ->allowedFields('author.id', 'author.name')  
    ->allowedIncludes('author')  
    ->get();

GET /posts?include=author&fields[author]=id,name

Return all post but only id and name of the author, but it doesn't work. It fetches all the authors fields.

Relationships

User model:

public function posts(): HasMany
    {
        return $this->hasMany(Post::class, 'author_id');
    }}

Post model:

public function author(): BelongsTo
   {
       return $this->belongsTo(User::class, 'author_id');
   }

I am doing something wrong or its a bug?
Thanks

[luizmagao]

Estou passando pelo mesmo problema, não sei como resolver ainda.

[inmass]

@JaviLerma @luizmagao
The current implementation doesn't work as expected due to several factors related to naming conventions and configuration:

1. Relationship and Table Naming:
   By default, the query builder expects plural names for relations and table names. For example:

   • 'author' should be 'authors'
   • 'postComment' should be 'postComments'

2. Using Singular Names:
   If you prefer to use singular naming for relationships, you need to publish the query-builder config file:
   php artisan vendor:publish --provider="Spatie\QueryBuilder\QueryBuilderServiceProvider" --tag="query-builder-config"
   Then, set convert_relation_names_to_snake_case_plural to false in the config file.

3. Relation ID Fields:
   Ensure you add the relation id to the fields param

4. Query Syntax:
   You can query related fields using either of these syntaxes:

• Dot notation: fields=id,title,car_model_id,carModel.id,carModel.slug
• Array notation: fields[carModel]=id,slug

These adjustments should resolve the issues with relationship querying and naming conventions in the current implementation.