wip

Author: tobyzerner

README.md

@@ -101,10 +101,10 @@ Define an [attribute field](https://jsonapi.org/format/#document-resource-object
 $schema->attribute('firstName');
 ```
 
-By default the attribute will correspond to the property on your model with the same name. (`EloquentAdapter` will `snake_case` it automatically for you.) If you'd like it to correspond to a different property, provide it as a second argument:
+By default the attribute will correspond to the property on your model with the same name. (`EloquentAdapter` will `snake_case` it automatically for you.) If you'd like it to correspond to a different property, use the `property` method:
 
 ```php
-$schema->attribute('firstName', 'fname');
+$schema->attribute('firstName')->property('fname');
 ```
 
 ### Relationships
@@ -122,7 +122,7 @@ By default the [resource type](https://jsonapi.org/format/#document-resource-obj
 $schema->hasOne('author')->type('people');
 ```
 
-Like attributes, the relationship will automatically read and write to the relation on your model with the same name. If you'd like it to correspond to a different relation, provide it as a third argument.
+Like attributes, the relationship will automatically read and write to the relation on your model with the same name. If you'd like it to correspond to a different relation, use the `property` method.
 
 #### Relationship Links
 
@@ -315,7 +315,7 @@ $schema->attribute('firstName')
     });
 ```
 
-If your attribute corresponds to some other form of data storage rather than a simple property on your model, you can use the `save` method to provide a closure to be run _after_ your model is saved:
+If your field corresponds to some other form of data storage rather than a simple property on your model, you can use the `save` method to provide a closure to be run _after_ your model is saved:
 
 ```php
 $schema->attribute('locale')

src/Adapter/EloquentAdapter.php

@@ -74,7 +74,8 @@ public function getHasOneId($model, HasOne $relationship): ?string
         $relation = $this->getRelation($model, $relationship);
 
         // If this is a belongs-to relation, we can simply return the value of
-        // the foreign key on the model.
+        // the foreign key on the model. Otherwise we will have to fetch the
+        // full related model and return its key.
         if ($relation instanceof BelongsTo) {
             return $model->{$relation->getForeignKeyName()};
         }

src/Handler/Concerns/IncludesData.php

@@ -7,7 +7,6 @@
 use function Tobyz\JsonApiServer\evaluate;
 use Tobyz\JsonApiServer\Exception\BadRequestException;
 use Tobyz\JsonApiServer\ResourceType;
-use Tobyz\JsonApiServer\Schema\HasMany;
 use Tobyz\JsonApiServer\Schema\Relationship;
 
 trait IncludesData

src/JsonApiResponse.php

@@ -8,9 +8,9 @@ class JsonApiResponse extends JsonResponse
 {
     public function __construct(
         $data,
-        $status = 200,
+        int $status = 200,
         array $headers = [],
-        $encodingOptions = self::DEFAULT_JSON_FLAGS
+        int $encodingOptions = self::DEFAULT_JSON_FLAGS
     ) {
         $headers['content-type'] = JsonApi::CONTENT_TYPE;
 

src/Schema/Field.php

@@ -166,6 +166,4 @@ public function getFilterable()
     {
         return $this->filterable;
     }
-
-
 }

src/Schema/Relationship.php

@@ -48,12 +48,12 @@ public function loadable(Closure $callback = null)
         return $this;
     }
 
-    public function notLoadable()
-    {
-        $this->loadable = false;
-
-        return $this;
-    }
+    // public function notLoadable()
+    // {
+    //     $this->loadable = false;
+    //
+    //     return $this;
+    // }
 
     public function includable()
     {

src/Serializer.php

@@ -17,7 +17,7 @@
 use Tobyz\JsonApiServer\Schema\Attribute;
 use Tobyz\JsonApiServer\Schema\Relationship;
 
-class Serializer
+final class Serializer
 {
     protected $api;
     protected $request;