Merge branch 'release/2.3.0'

lindyhopchris · lindyhopchris · commit ab96aa6a5ddc · 2023-01-15T17:53:52.000Z
diff --git a/1.0/requests/authorization.md b/1.0/requests/authorization.md
@@ -641,7 +641,7 @@ we can register it for multiple resource types as follows:
 
 ```php
 use App\JsonApi\Authorizers\BlogAuthorizer;
-use LaravelJsonApi\LaravelJsonApi;
+use LaravelJsonApi\Laravel\LaravelJsonApi;
 
 public function register(): void
 {
@@ -668,7 +668,7 @@ To register your default implementation, use the `register` method of your
 
 ```php
 use App\JsonApi\Authorizers\DefaultAuthorizer;
-use LaravelJsonApi\LaravelJsonApi;
+use LaravelJsonApi\Laravel\LaravelJsonApi;
 
 public function register(): void
 {
diff --git a/1.0/tutorial/08-fetching-resources.md b/1.0/tutorial/08-fetching-resources.md
@@ -268,7 +268,7 @@ have a `UserFactory.php` file that helps us create `User` models.
 Add a factory for our `Post` model using the following command:
 
 ```bash
-vendor/bin/sail make:factory PostFactory
+vendor/bin/sail artisan make:factory PostFactory
 ```
 
 That will create the `database/factories/PostFactory.php` file. Open that up
diff --git a/2.0/requests/authorization.md b/2.0/requests/authorization.md
@@ -641,7 +641,7 @@ we can register it for multiple resource types as follows:
 
 ```php
 use App\JsonApi\Authorizers\BlogAuthorizer;
-use LaravelJsonApi\LaravelJsonApi;
+use LaravelJsonApi\Laravel\LaravelJsonApi;
 
 public function register(): void
 {
@@ -668,7 +668,7 @@ To register your default implementation, use the `register` method of your
 
 ```php
 use App\JsonApi\Authorizers\DefaultAuthorizer;
-use LaravelJsonApi\LaravelJsonApi;
+use LaravelJsonApi\Laravel\LaravelJsonApi;
 
 public function register(): void
 {
diff --git a/2.0/schemas/eager-loading.md b/2.0/schemas/eager-loading.md
@@ -131,6 +131,26 @@ As this relationship endpoint returns `comments` resources, the allowed
 include paths are determined by the `CommentSchema` class.
 :::
 
+### Conditionally Disabling on Specific Relations
+
+If you need to conditionally disable eager-loading on a relationship, use
+the `canEagerLoad()` method. You can provide a boolean, for example:
+
+```php
+HasMany::make('comments')->canEagerLoad(
+    Gate::allows('viewComments', Post::class),
+)
+```
+
+Alternatively, you can provide a callback to determine if eager loading is
+allowed:
+
+```php
+HasMany::make('comments')->canEagerLoad(
+    fn() => Gate::allows('viewComments', Post::class),
+)
+```
+
 ## Disabling On A Resource Type
 
 To disable eager loading for a resource type, set the `$maxDepth` property
diff --git a/2.0/schemas/filters.md b/2.0/schemas/filters.md
@@ -243,6 +243,7 @@ Laravel JSON:API ships with the following filters:
 - [WhereIdNotIn](#whereidnotin)
 - [WhereIn](#wherein)
 - [WhereNotIn](#wherenotin)
+- [WhereNull / WhereNotNull](#wherenull-wherenotnull)
 - [WherePivot](#wherepivot)
 - [WherePivotIn](#wherepivotin)
 - [WherePivotNotIn](#wherepivotnotin)
@@ -645,6 +646,40 @@ string values if a delimiter is set:
 WhereNotIn('not-category', 'category')->delimiter(',')
 ```
 
+### WhereNull / WhereNotNull
+
+The `WhereNull` and `WhereNotNull` filters can be used to filter resources
+by a column that supports `null` values. The use of these two filters is
+best explained using an example.
+
+Imagine a scenario where a `Post` model has a `published_at` column. The
+value in this column indicates whether the blog post has been published.
+If it holds `null`, the blog post is not published (aka is a draft post).
+If it holds a date time, the blog post is published.
+
+In this scenario, you would use the `WhereNull` filter like this:
+
+```php
+WhereNull::make('draft', 'published_at')
+```
+
+In this case, if the client provided `true` as the `draft` filter value,
+the response would contain resources where the column value is `null` -
+i.e. the blog posts are draft posts. Providing `false` as the filter
+value would result in blog posts that are not draft, i.e. published.
+
+Alternatively, you could use the `WhereNotNull` filter like this:
+
+```php
+WhereNotNull::make('published', 'published_at')
+```
+
+In this case, if the client provided `true` as the `published` filter
+value, the response would contain resources where the column value is
+a date time - i.e. the blog posts are published. Providing `false`
+as the filter value would result in blog posts that are not published,
+i.e. are draft and have a `null` value for the column.
+
 ### WherePivot
 
 The `WherePivot` filter can be used on a
diff --git a/2.0/tutorial/08-fetching-resources.md b/2.0/tutorial/08-fetching-resources.md
@@ -268,7 +268,7 @@ have a `UserFactory.php` file that helps us create `User` models.
 Add a factory for our `Post` model using the following command:
 
 ```bash
-vendor/bin/sail make:factory PostFactory
+vendor/bin/sail artisan make:factory PostFactory
 ```
 
 That will create the `database/factories/PostFactory.php` file. Open that up
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -641,7 +641,7 @@ we can register it for multiple resource types as follows:`
`641`	`641`
`642`	`642`	```php
`643`	`643`	`use App\JsonApi\Authorizers\BlogAuthorizer;`
`644`		`-use LaravelJsonApi\LaravelJsonApi;`
	`644`	`+use LaravelJsonApi\Laravel\LaravelJsonApi;`
`645`	`645`
`646`	`646`	`public function register(): void`
`647`	`647`	`{`
@@ -668,7 +668,7 @@ To register your default implementation, use the `register` method of your
`668`	`668`
`669`	`669`	```php
`670`	`670`	`use App\JsonApi\Authorizers\DefaultAuthorizer;`
`671`		`-use LaravelJsonApi\LaravelJsonApi;`
	`671`	`+use LaravelJsonApi\Laravel\LaravelJsonApi;`
`672`	`672`
`673`	`673`	`public function register(): void`
`674`	`674`	`{`