Merge branch 'release/3.1.0'

Author: lindyhopchris

1.0/responses/README.md

@@ -72,7 +72,7 @@ constructor, or the static `make` method if you need to chain any of our
 helper methods. For example:
 
 ```php
-use LaravelJsonApi\Core\Response\DataResponse;
+use LaravelJsonApi\Core\Responses\DataResponse;
 
 return new DataResponse($model);
 // or
@@ -117,7 +117,7 @@ To create a related response, you need to provide three arguments:
 For example, given a `post` model, with a `tags` relationship:
 
 ```php
-use LaravelJsonApi\Core\Response\RelatedResponse;
+use LaravelJsonApi\Core\Responses\RelatedResponse;
 
 return new RelatedResponse($post, 'tags', $post->tags);
 // or
@@ -156,7 +156,7 @@ To create a relationship response, you need to provide three arguments:
 For example, given a `post` model, with a `tags` relationship:
 
 ```php
-use LaravelJsonApi\Core\Response\RelationshipResponse;
+use LaravelJsonApi\Core\Responses\RelationshipResponse;
 
 return new RelationshipResponse($post, 'tags', $post->tags);
 // or
@@ -187,7 +187,7 @@ a Laravel collection.
 For example:
 
 ```php
-use LaravelJsonApi\Core\Response\MetaResponse;
+use LaravelJsonApi\Core\Responses\MetaResponse;
 
 return new MetaResponse(['foo' => 'bar']);
 // or

1.0/routing/README.md

@@ -62,7 +62,7 @@ JsonApiRoute::server('v1')
     ->prefix('v1')
     ->resources(function ($server) {
         $server->resource('posts', PostController::class);
-        $server->resources('tags', TagController::class);
+        $server->resource('tags', TagController::class);
     });
 ```
 
@@ -76,7 +76,7 @@ JsonApiRoute::server('v1')
     ->prefix('v1')
     ->resources(function ($server) {
         $server->resource('posts', JsonApiController::class);
-        $server->resources('tags', JsonApiController::class);
+        $server->resource('tags', JsonApiController::class);
     });
 ```
 

1.0/tutorial/08-fetching-resources.md

@@ -1407,7 +1407,7 @@ is in the `PostSchema` class - e.g. ensuring that a provided `sort` parameter
 is a field that is actually marked as sortable.
 
 We can improve the validation to ensure there are some more specific rules,
-e.g. ensuring the the `author` filter only receives integer ids.
+e.g. ensuring the `author` filter only receives integer ids.
 
 Run the following command:
 

2.0/responses/README.md

@@ -72,7 +72,7 @@ constructor, or the static `make` method if you need to chain any of our
 helper methods. For example:
 
 ```php
-use LaravelJsonApi\Core\Response\DataResponse;
+use LaravelJsonApi\Core\Responses\DataResponse;
 
 return new DataResponse($model);
 // or
@@ -117,7 +117,7 @@ To create a related response, you need to provide three arguments:
 For example, given a `post` model, with a `tags` relationship:
 
 ```php
-use LaravelJsonApi\Core\Response\RelatedResponse;
+use LaravelJsonApi\Core\Responses\RelatedResponse;
 
 return new RelatedResponse($post, 'tags', $post->tags);
 // or
@@ -156,7 +156,7 @@ To create a relationship response, you need to provide three arguments:
 For example, given a `post` model, with a `tags` relationship:
 
 ```php
-use LaravelJsonApi\Core\Response\RelationshipResponse;
+use LaravelJsonApi\Core\Responses\RelationshipResponse;
 
 return new RelationshipResponse($post, 'tags', $post->tags);
 // or
@@ -187,7 +187,7 @@ a Laravel collection.
 For example:
 
 ```php
-use LaravelJsonApi\Core\Response\MetaResponse;
+use LaravelJsonApi\Core\Responses\MetaResponse;
 
 return new MetaResponse(['foo' => 'bar']);
 // or

2.0/routing/README.md

@@ -62,7 +62,7 @@ JsonApiRoute::server('v1')
     ->prefix('v1')
     ->resources(function ($server) {
         $server->resource('posts', PostController::class);
-        $server->resources('tags', TagController::class);
+        $server->resource('tags', TagController::class);
     });
 ```
 
@@ -76,7 +76,7 @@ JsonApiRoute::server('v1')
     ->prefix('v1')
     ->resources(function ($server) {
         $server->resource('posts', JsonApiController::class);
-        $server->resources('tags', JsonApiController::class);
+        $server->resource('tags', JsonApiController::class);
     });
 ```
 

2.0/tutorial/05-creating-resources.md

@@ -166,7 +166,7 @@ Open the `app/JsonApi/V1/Server.php` class, and update it as follows:
      {
 -       // no-op
 +       Post::creating(static function (Post $post): void {
-+.           $post->author()->associate(Auth::user());
++           $post->author()->associate(Auth::user());
 +       });
      }
 

2.0/tutorial/08-fetching-resources.md

@@ -1407,7 +1407,7 @@ is in the `PostSchema` class - e.g. ensuring that a provided `sort` parameter
 is a field that is actually marked as sortable.
 
 We can improve the validation to ensure there are some more specific rules,
-e.g. ensuring the the `author` filter only receives integer ids.
+e.g. ensuring the `author` filter only receives integer ids.
 
 Run the following command:
 

3.0/getting-started/upgrade.md

@@ -2,6 +2,21 @@
 
 [[toc]]
 
+## Upgrading to 3.x from 2.x
+
+Version 3.0 upgrades the package to Laravel 10. There are no significant
+breaking changes, so you should be able to immediately upgrade when you
+upgrade your application to Laravel 10. The minor breaking changes are
+detailed in the [release.](https://github.com/laravel-json-api/laravel/releases/tag/v3.0.0)
+
+To upgrade, run the following commands:
+
+```bash
+composer require laravel-json-api/laravel --no-update
+composer require laravel-json-api/testing --dev --no-update
+composer up "laravel-json-api/*" cloudcreativity/json-api-testing
+```
+
 ## Upgrading to 2.x from 1.x
 
 Version 2.0 adds support for PHP 8.1, and supports both Laravel 8 and 9.

3.0/responses/README.md

@@ -72,7 +72,7 @@ constructor, or the static `make` method if you need to chain any of our
 helper methods. For example:
 
 ```php
-use LaravelJsonApi\Core\Response\DataResponse;
+use LaravelJsonApi\Core\Responses\DataResponse;
 
 return new DataResponse($model);
 // or
@@ -117,7 +117,7 @@ To create a related response, you need to provide three arguments:
 For example, given a `post` model, with a `tags` relationship:
 
 ```php
-use LaravelJsonApi\Core\Response\RelatedResponse;
+use LaravelJsonApi\Core\Responses\RelatedResponse;
 
 return new RelatedResponse($post, 'tags', $post->tags);
 // or
@@ -156,7 +156,7 @@ To create a relationship response, you need to provide three arguments:
 For example, given a `post` model, with a `tags` relationship:
 
 ```php
-use LaravelJsonApi\Core\Response\RelationshipResponse;
+use LaravelJsonApi\Core\Responses\RelationshipResponse;
 
 return new RelationshipResponse($post, 'tags', $post->tags);
 // or
@@ -187,7 +187,7 @@ a Laravel collection.
 For example:
 
 ```php
-use LaravelJsonApi\Core\Response\MetaResponse;
+use LaravelJsonApi\Core\Responses\MetaResponse;
 
 return new MetaResponse(['foo' => 'bar']);
 // or

3.0/routing/README.md

@@ -23,10 +23,12 @@ your `routes/api.php` file as follows:
 use App\Http\Controllers\Api\V1\PostController;
 use App\Http\Controllers\Api\V1\TagController;
 use App\Http\Controllers\Api\V1\UserController;
+use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
+use LaravelJsonApi\Laravel\Routing\ResourceRegistrar;
 
 JsonApiRoute::server('v1')
     ->prefix('v1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
         $server->resource('tags', TagController::class);
         $server->resource('users', UserController::class);
@@ -57,32 +59,36 @@ routes. For example:
 ```php
 use App\Http\Controllers\Api\V1\PostController;
 use App\Http\Controllers\Api\V1\TagController;
+use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
+use LaravelJsonApi\Laravel\Routing\ResourceRegistrar;
 
 JsonApiRoute::server('v1')
     ->prefix('v1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
-        $server->resources('tags', TagController::class);
+        $server->resource('tags', TagController::class);
     });
 ```
 
 As controllers are optional, it is also possible to use the default
 `JsonApiController`. For example:
 
 ```php
+use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
 use LaravelJsonApi\Laravel\Http\Controllers\JsonApiController;
+use LaravelJsonApi\Laravel\Routing\ResourceRegistrar;
 
 JsonApiRoute::server('v1')
     ->prefix('v1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', JsonApiController::class);
-        $server->resources('tags', JsonApiController::class);
+        $server->resource('tags', JsonApiController::class);
     });
 ```
 
 Both the above examples work if the `$namespace` property of your application's
 `RouteServiceProvider` is **not** set. This is the case in a fresh installation
-of a Laravel 8 application.
+of a Laravel >=8 application.
 
 Traditionally, Laravel's route groups have allowed controller namespaces
 to be set via groups. This works if the `$namespace` property on your
@@ -100,7 +106,7 @@ the `App\Http\Controllers\Api\V1` namespace:
 JsonApiRoute::server('v1')
     ->prefix('v1')
     ->namespace('Api\V1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         // Expects controller to be `App\Http\Api\V1\PostController`
         $server->resource('posts');
     });
@@ -117,7 +123,7 @@ controller name as the second argument to the `resource()` method:
 JsonApiRoute::server('v1')
     ->prefix('v1')
     ->namespace('Api\V1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         // Controller is `App\Http\Api\V1\BlogPostController`
         $server->resource('posts', 'BlogPostController');
     });
@@ -128,12 +134,14 @@ When using controller namespacing, if you want to use the generic
 `resource()` method. For example:
 
 ```php
+use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
 use LaravelJsonApi\Laravel\Http\Controllers\JsonApiController;
+use LaravelJsonApi\Laravel\Routing\ResourceRegistrar;
 
 JsonApiRoute::server('v1')
     ->prefix('v1')
     ->namespace('Api\V1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', '\\' . JsonApiController::class);
     });
 ```
@@ -146,7 +154,7 @@ For example:
 ```php
 JsonApiRoute::server('v1')
     ->domain('api.myapp.com')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
         $server->resource('tags', TagController::class);
         $server->resource('users', UserController::class);
@@ -158,7 +166,7 @@ Or if you had wildcard sub-domains:
 ```php
 JsonApiRoute::server('v1')
     ->domain('{account}.myapp.com')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
         $server->resource('tags', TagController::class);
         $server->resource('users', UserController::class);
@@ -181,7 +189,7 @@ In this example:
 JsonApiRoute::server('v1')
     ->middleware('my-middleware1', 'my-middleware2')
     ->prefix('v1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
     });
 ```
@@ -200,7 +208,7 @@ Route::middleware('my-middleware1')->group(function () {
     JsonApiRoute::server('v1')
       ->middleware('my-middleware2')
       ->prefix('v1')
-      ->resources(function ($server) {
+      ->resources(function (ResourceRegistrar $server) {
           $server->resource('posts', PostController::class);
       });
 });
@@ -225,7 +233,7 @@ In the following example, we override the default route name of `v1` to
 JsonApiRoute::server('v1')
     ->name('api:v1')
     ->prefix('v1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
     });
 ```
@@ -241,7 +249,7 @@ For example, the following registers routes for the `posts`, `tags` and
 ```php
 JsonApiRoute::server('v1')
     ->prefix('v1')
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
         $server->resource('tags', TagController::class);
         $server->resource('users', UserController::class);
@@ -348,7 +356,9 @@ For example, if we want to register routes for a `posts` resource's
 `author`, `comments` and `tags` relationships:
 
 ```php
-$server->resource('posts')->relationships(function ($relationships) {
+use LaravelJsonApi\Laravel\Routing\Relationships;
+
+$server->resource('posts')->relationships(function (Relationships $relationships) {
   $relationships->hasOne('author');
   $relationships->hasMany('comments');
   $relationships->hasMany('tags');
@@ -417,7 +427,8 @@ Use our short-hands of `related`, `show`, `update`, `attach` and `detach`
 for the actions:
 
 ```php
-$relationships->hasOne('author')
+$relationships
+  ->hasOne('author')
   ->name('related', 'author.related')
   ->name('show', 'author.relationships.show');
 // is identical to...
@@ -475,7 +486,7 @@ JSON:API routes:
 JsonApiRoute::server('v1')
     ->prefix('v1')
     ->withoutMiddleware(\Illuminate\Routing\Middleware\SubstituteBindings::class)
-    ->resources(function ($server) {
+    ->resources(function (ResourceRegistrar $server) {
         $server->resource('posts', PostController::class);
     });
 ```