Releases: dedoc/scramble
v0.6.0
What's Changed
- Added support of responsable exceptions as responses (403, 422, 404) by @romalytvynenko in #65
- Added resource collections support by @romalytvynenko in #64
- Added support for
true
andfalse
expressions by @romalytvynenko in #58 - Added literals support to PHPDoc types by @romalytvynenko in #59
- Fixed an error that happened when combining responses with empty body and the same status by @romalytvynenko in #60
- Fixed flawed path param aliasing to the var name by @romalytvynenko in #63
Full Changelog: v0.5.0...v0.6.0
v0.5.0
🫣 Breaking change
Applicable if you've published Scramble's config or relied on the default route resolver behavior (which resolved routes by looking if a route uses api
middleware). In most cases you shouldn't really be affected by the change unless you modified API base URL.
In 0.4.0
I've introduced api_base_url
config that allowed configuring and modifying API base URL. By default it was url('/api')
. Sadly enough, using url
in config file caused php artisan serve
to fail with the following error:
Illuminate\Routing\UrlGenerator::__construct(): Argument #2 ($request) must be of type Illuminate\Http\Request, null given,
called in /***/vendor/laravel/framework/src/Illuminate/Routing/RoutingServiceProvider.php on line
67
To fix the issue I decided to go away from the idea of using url
helper in config and instead, and introduced api_path
config. So now this part of the config is much simpler and looks like 'api_path' => 'api'
.
Also, the default behavior of the default routes resolver changed as well. Previously it took all the routes that were using api
middleware. From now on, by default all the routes which URL starts with api/
(scramble.api_path
) will be used.
Full Changelog: v0.4.0...v0.5.0
v0.4.0
What's Changed
- Added models support (both for schema and responses) by @romalytvynenko in #22
- Added manual response type hints support to describe responses in docs by @romalytvynenko in #33
- Added ability to customize API base URL, version, and description by @romalytvynenko in #41
- Added ability to disable security on a route by @romalytvynenko in #43
- Fixed an error happening when
$table
in model's class is not a string (but array) by @romalytvynenko in #42 - Fixed a case when function return type annotation caused a loss of the available details about the actual return type by @romalytvynenko in #39
Full Changelog: v0.3.0...v0.4.0
v0.3.0
What's Changed
- Added Enums support by @romalytvynenko in #21
- Added
uuid
validation rule support by @romalytvynenko in #28 - Added manual
Illuminate
responses constructor support,make
on the resource by @romalytvynenko in #29 - Not using closure based routes for docs when routes are cached by @romalytvynenko in #30
- Improved
whenLoaded
support by @romalytvynenko in #32 - Fix circular references in resources by @romalytvynenko in #32
- Fix Stoplight typo by @peterbrinck in #20
New Contributors
- @peterbrinck made their first contribution in #20
Full Changelog: v0.2.0...v0.3.0
v0.2.0
What's Changed
- Added documenting security of the APIs by @romalytvynenko in #19
Full Changelog: v0.1.0...v0.2.0
v0.1.0
What's Changed
- Correct
exists
rule support, type format support (email
) by @romalytvynenko in #12 - Add support for
Validator::make
facade call for request body definition by @romalytvynenko in #13 - Support for response factory (
response()
call) and some of its methods (make
,noContent
,json
) by @romalytvynenko in #14 - Multiple responses support for a single action by @romalytvynenko in #15
Full Changelog: v0.0.2...v0.1.0
v0.0.2
Fixes
- Removed debug messages.
- Fixed incorrect namespace for the
TypeAttributes
trait (it didn't break anything but indeed should not be like that).
Full Changelog: v0.0.1...v0.0.2
v0.0.1
What's Changed
- Finalizing extensions API by @romalytvynenko in #3
- Request parameters improvements: nested rules support, support both
FormRequest
rules and rules in a controller by @romalytvynenko in #4
Full Changelog: v0.0.1-alpha.5...v0.0.1
v0.0.1-alpha.5
Working on new extensions API.
v0.0.1-alpha.4
Basic type inference from code for better responses docs in progress.