Releases
8.1.0 4/14/2023
Added
- Invokable Getters https://restify.binarcode.com/api/getters/#invokable-getter-format
- Invokable Actions https://restify.binarcode.com/api/actions/#invokable-action-format
8.0.1 4/14/2023
Fixed
- docs for getters #554
8.0.0 4/6/2023
Added
- Support for Laravel 10 #540
- Introduces a new option to publish specific auth actions #551
- Take actionable fields into account when calling patch method #547
- Custom namespaces support #549
- New
artisan restify:routes
comment - Updated the documentation https://restify.binarcode.com/
- 💯 - 💯 - 💯 - 💯
Improved
- Larastan specs
7.11.0 3/16/2023
Added
- Support for actionable fields on PATCH method #547
thanks @dsindrilaru
7.10.11 2/12/2023
Added
- Now you can use the permission name for the field see authorization:
field('user_id')->canSeeWhen('can manage users'),
7.10.4 2/11/2023
Fixed
- Do not display hidden pivots.
7.10.3 2/11/2023
Fixed
- fix: do not filter belongs to many fields
7.10.2 2/4/2023
Fixed
- Return a collection with only its values, without any keys or indexes (if it's an associative array). https://github.com/BinarCode/laravel-restify/issues/524
7.10.1 2/4/2023
Fixed
- Show the full path for the file when suggesting OpenAI solution.
7.10.0 2/4/2023
Inspired and thanks to Marcel for the article: https://beyondco.de/blog/ai-powered-error-solutions-for-laravel
Generate solution
Restify can generate an AI based solution to your problem. In order to enable that you need to extend the App\Exceptions\Handler
with the Binaryk\LaravelRestify\Exceptions\RestifyHandler
:
use Binaryk\LaravelRestify\Exceptions\RestifyHandler;
use Throwable;
class Handler extends RestifyHandler
{
//...
}
This feature is using the openai-php/laravel, you should also publish the config file:
php artisan vendor:publish --provider="OpenAI\Laravel\ServiceProvider"
and set the OPENAI_API_KEY
in the .env
file.
The OpenAI key can be obtained from here.
Now the solution to your problems will automatically appear in the response:
{
"restify-solution": "Line 67 in DocumentRepository.php file has an error because the method `resolveUsingFullPath()` is not defined. The code should look like this:\n```\n->resolveUsingTemporaryUrl($request->boolean('temporary'))\n```\n",
"message": "Call to undefined method Binaryk\\LaravelRestify\\Fields\\File::resolveUsingFullPath()",
"exception": "Error",
"file": "/Users/eduardlupacescu/Sites/binarcode/erp/app/Restify/DocumentRepository.php",
"line": 67,
"trace": [
...
}
Disable solution
If you want to disable the solution feature you can set the restify.ai_solution
to false
in the config/restify.php
file so Restify will not call the OpenAI API even you extended the exception handler. This might be useful in automated tests or other environments:
// config/restify.php
'ai_solutions' => true,
7.9.0 2/3/2023
Added
Customizing File Display
By default, Restify will display the file's stored path name. However, you may customize this behavior.
Displaying temporary url
For disks such as S3, you may instruct Restify to display a temporary URL to the file instead of the stored path name:
field('path')
->file()
->path("documents/".Auth::id())
->resolveUsingTemporaryUrl()
->disk('s3'),
The resolveUsingTemporaryUrl
accepts 3 arguments:
$resolveTemporaryUrl
- a boolean to determine if the temporary url should be resolved. Defaults totrue
.$expiration
- A CarbonInterface to determine the time before the URL expires. Defaults to 5 minutes.$options
- An array of options to pass to thetemporaryUrl
method of theIlluminate\Contracts\Filesystem\Filesystem
implementation. Defaults to an empty array.
Displaying full url
For disks such as public
, you may instruct Restify to display a full URL to the file instead of the stored path name:
field('path')
->file()
->path("documents/".Auth::id())
->resolveUsingFullUrl()
->disk('public'),
Fixed
- fix: fixing dynamic user class
7.8.0 1/17/2023
Added
- Now you can add a placeholder to the filter, so it renders on the frontend
'title' => MatchFilter::make()
->setDescription('Sort by title')
->setPlaceholder('-title')
->setType('string')
When we read match filters using: `/api/restify/posts/filters?only=matches` we will get:
[
"type" => "string"
"advanced" => false
"title" => "Title"
"description" => "Sort by title"
"placeholder" => "-title"
"column" => "title"
"key" => "matches"
]
Fixed
- Tests (thanks @arthurkirkosa)
7.7.2 1/13/2023
Fixed
- Profile request class
7.7.1 11/22/2022
Fixed
- Remove Email Exist validation #518
7.7.0 9/17/2022
Sync related
You can also sync
your BelongsToMany
field. Say you have to sync permissions to a role. You can do it like this:
POST: api/restify/roles/1/sync/permissions
Payload:
{
"permissions": [1, 2]
}
Under the hood this will call the sync
method on the BelongsToMany
relationship:
// $role of the id 1
$role->permissions()->sync($request->input('permissions'));
Authorize sync
You can define a policy method syncPermissions
. The name should start with sync
and suffix with the plural CamelCase
name of the model's relationship name:
// RolePolicy.php
public function syncPermissions(User $authenticatedUser, Company $company, Collection $keys): bool
{
// $keys are the primary keys of the related model (permissions in our case) Restify is trying to `sync`
}
7.6.3 9/16/2022
Fixed
- The rest method will consider the meta information for the rest helper:
rest($user)->indexMeta(['token' => $token])
7.6.2 9/15/2022
Fixed
- Belongs search with custom foreign key https://github.com/BinarCode/laravel-restify/pull/512
Inherited https://github.com/BinarCode/laravel-restify/releases/tag/6.12.2
7.6.1 9/15/2022
Added
- Serializer - Serialize One model or nothing using the show response format #510
Fixed
- Listing routes in console #514
7.6.0 9/15/2022
Added
- The
policyMeta
method is now protected at the repository level (it could be used to override the policy information for the show and index methods. - Do not make
RelatedDto
as a singleton in a test environment (this causes issues when trying to make few relationship requests to the same repository in the same test)
Fixed
- Always public index method if no policy
- Unit test that shows routes list command.
- Fix Gate::check - show - not working
Support
- Added unit tests for the testing helpers (
action
,route
andgetters
).
6.12.2 9/15/2022
Fixed
- Belongs search with custom foreign key #512
7.5.4 8/2/2022
Fixed
- The unauthorized code should be 401.
7.5.3 8/1/2022
Refactored
- The testing
Repository::route(
method has a new signature, it accepts theaction
as well now.
7.5.2 7/30/2022
Fixed
- Cache enable option is considered during the policy methods check.
7.5.1 7/30/2022
Fixed
- Action logs should be enabled now.
7.5.0 7/30/2022
Added
This will enable policies to be cached by adding the configuration:
'cache' => [
/*
| Specify the cache configuration for the resources policies.
| When enabled, methods from the policy will be cached for the active user.
*/
'policies' => [
'enabled' => true,
/*
| ttl in seconds
*/
'ttl' => 5 * 60,
],
],
7.4.0 7/29/2022
Added
- Added support for nested relationships when you want to get the parent and children in the same query. Imagine a tweet thread, where you want to list all tweets with its parent tweet along with its immediate children tweets. This is now possible and will do not run into infinite loop issue.
Fixed
- Support to mock repositories using
YourRepository::partialMock()
for the index request, previously it ran into the mock state and didn't update the second resources in tests.
Breaking
- The
$eagerState
repository property is now private, and it is of typenull|string
because it holds the parent repository that renders it.
7.3.1 7/26/2022
Fixed
- Publish provider before routes so
restifyAuth
macro works.
7.3.0 7/25/2022
Added
- Singleton could be loaded from the
RestifyServiceProvider
in the local repository so the dev will have control over that.
7.2.1 7/24/2022
Fixed
- Nova routes conflict.
7.2.0 7/24/2022
Added
- Loading routes from the LaraveRestifyApplicationProvider so developers could override or comment that out.