Skip to content

Releases: dedoc/scramble

v0.6.0

07 Nov 19:31
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.5.0...v0.6.0

v0.5.0

02 Oct 17:26
Compare
Choose a tag to compare

🫣 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

01 Oct 21:14
Compare
Choose a tag to compare

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

23 Sep 16:20
811c9ba
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v0.2.0...v0.3.0

v0.2.0

20 Sep 21:10
d06deab
Compare
Choose a tag to compare

What's Changed

Full Changelog: v0.1.0...v0.2.0

v0.1.0

19 Sep 19:31
Compare
Choose a tag to compare

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

19 Sep 12:23
Compare
Choose a tag to compare

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

17 Sep 18:47
Compare
Choose a tag to compare

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

07 Sep 15:02
fb6c15a
Compare
Choose a tag to compare
v0.0.1-alpha.5 Pre-release
Pre-release

Working on new extensions API.

v0.0.1-alpha.4

01 Sep 08:41
6168cbe
Compare
Choose a tag to compare
v0.0.1-alpha.4 Pre-release
Pre-release

Basic type inference from code for better responses docs in progress.