scramble

What's Changed

• Fixed property fetching inference by @romalytvynenko in https://github.com/dedoc/scramble/pull/381
• Fixed relations retrieval for child models by @romalytvynenko in https://github.com/dedoc/scramble/pull/381

Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.5...v0.10.6

What's Changed

• Added tests for routes-related features by @romalytvynenko in https://github.com/dedoc/scramble/pull/376
• Improve inferring model property types, based on DB driver by @kburton-dev in https://github.com/dedoc/scramble/pull/375
• Support for additional on anonymous collections by @romalytvynenko in https://github.com/dedoc/scramble/pull/377
• Taking into account deeper binary fields in request body parameters when determining default request media type by @romalytvynenko in https://github.com/dedoc/scramble/pull/378
• Using method's real class' reflection when analyzing parent class' methods calls by @romalytvynenko in https://github.com/dedoc/scramble/pull/379
• Improved errors documentation by avoiding documenting errors when authorize or rules methods are not defined on a custom form request class by @romalytvynenko in https://github.com/dedoc/scramble/pull/380

Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.4...v0.10.5

What's Changed

• Fix default API route resolver register order issue by @romalytvynenko in https://github.com/dedoc/scramble/pull/373

Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.3...v0.10.4

What's Changed

• Fixed routes serialization issue by @romalytvynenko in https://github.com/dedoc/scramble/pull/371

Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.2...v0.10.3

What's Changed

• Fixed routes serialization error by @romalytvynenko in https://github.com/dedoc/scramble/pull/370

Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.1...v0.10.2

What's Changed

• Fixed inferring params from request method calls by @romalytvynenko in https://github.com/dedoc/scramble/pull/367

Full Changelog: https://github.com/dedoc/scramble/compare/v0.10.0...v0.10.1

What's Changed

Added

• Ability to configure more API versions docs, customize docs domains and paths by @romalytvynenko in https://github.com/dedoc/scramble/pull/350
• Added ability to specify data format in API resources by @romalytvynenko in https://github.com/dedoc/scramble/pull/351
• Added ability to override tag generation behaviour by @WildEgo in https://github.com/dedoc/scramble/pull/323
• Make TryIt work with Sanctum's cookie based authentication out of the box by @layerok in https://github.com/dedoc/scramble/pull/336
• Added @example support to API resources' attributes by @romalytvynenko in https://github.com/dedoc/scramble/pull/342
• Add tuples support by @romalytvynenko in https://github.com/dedoc/scramble/pull/343
• Add support for enums in route parameter by @rra3b in https://github.com/dedoc/scramble/pull/334
• Request params inference from method calls on request, default request values support by @romalytvynenko in https://github.com/dedoc/scramble/pull/356
• Determine eloquent attribute type from casts by @kburton-dev in https://github.com/dedoc/scramble/pull/345

Fixes

• Fix confirmed rule not working properly when it is used on multiple attributes by @nicolaubrasil in https://github.com/dedoc/scramble/pull/339
• Fixed shorthand ternaries by @hn-seoai in https://github.com/dedoc/scramble/pull/366

Changes

• Resolve ternary types properly by @kburton-dev in https://github.com/dedoc/scramble/pull/341
• Remove request body from HEAD and DELETE by default by @manuel-watchenterprise in https://github.com/dedoc/scramble/pull/346
• Sort validation rules by nesting deepness before documenting them to make results consistent by @romalytvynenko in https://github.com/dedoc/scramble/pull/362

New Contributors

• @rra3b made their first contribution in https://github.com/dedoc/scramble/pull/334
• @nicolaubrasil made their first contribution in https://github.com/dedoc/scramble/pull/339
• @kburton-dev made their first contribution in https://github.com/dedoc/scramble/pull/341
• @hn-seoai made their first contribution in https://github.com/dedoc/scramble/pull/366

Full Changelog: https://github.com/dedoc/scramble/compare/v0.9.0...v0.10.0

What's Changed

🚨 Breaking changes 🚨

• Dropped support of 8.x and 9.x Laravel versions as they've reached EOL.

If there are any problems when running composer update dedoc/scramble, include -W flag to update other dependencies as well. The issue may be caused in some rare cases by php-parser being changed to 5.0.* from 4.0.*.

Added

• Laravel 11 Support by @romalytvynenko in https://github.com/dedoc/scramble/pull/327
• scramble:export command to export specification's json by @princejohnsantillan in https://github.com/dedoc/scramble/pull/277

Changes

• Rollback default theme to light by @romalytvynenko in https://github.com/dedoc/scramble/pull/331

Fixes

• Fixed empty security descriptor by @manuel-watchenterprise in https://github.com/dedoc/scramble/pull/330
• Fixed Carbon attributes in resources being not documented as string<date-time> in Open API spec by @romalytvynenko in https://github.com/dedoc/scramble/pull/332

New Contributors

• @princejohnsantillan made their first contribution in https://github.com/dedoc/scramble/pull/277

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.6...v0.9.0

What's Changed

Added

• Add @deprecated tag support by @sc-bruno in https://github.com/dedoc/scramble/pull/296
• Ability to choose light or dark theme by @jeffreyvanhees in https://github.com/dedoc/scramble/pull/297

Fixes

• Fixed invalid OpenAPI spec when returning no content response by @romalytvynenko in https://github.com/dedoc/scramble/pull/289
• scopes property in OAuth made required according OpenAPI spec by @Neorej in https://github.com/dedoc/scramble/pull/318
• Respect string type when parsing validation rules' examples by @joligoms in https://github.com/dedoc/scramble/pull/315
• Fixed the case when non-request class had rules method which resulted in error when extracting validation rules by @romalytvynenko in https://github.com/dedoc/scramble/pull/324

New Contributors

• @sc-bruno made their first contribution in https://github.com/dedoc/scramble/pull/292
• @jeffreyvanhees made their first contribution in https://github.com/dedoc/scramble/pull/297
• @Neorej made their first contribution in https://github.com/dedoc/scramble/pull/318
• @joligoms made their first contribution in https://github.com/dedoc/scramble/pull/315

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.5...v0.8.6

What's Changed

Added

• Add whenCounted support in API resources by @vovarudomanenko in https://github.com/dedoc/scramble/pull/236
• Added support for min and max rules on arrays by @Carnicero90 in https://github.com/dedoc/scramble/pull/244

Fixes

• Fixed 'Try it' not working with Laravel Sanctum by @vovarudomanenko in https://github.com/dedoc/scramble/pull/243
• Fixed error when trying to access tag data by @rolexam in https://github.com/dedoc/scramble/pull/270

New Contributors

• @vovarudomanenko made their first contribution in https://github.com/dedoc/scramble/pull/236
• @Carnicero90 made their first contribution in https://github.com/dedoc/scramble/pull/244
• @rolexam made their first contribution in https://github.com/dedoc/scramble/pull/270

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.4...v0.8.5

What's Changed

Added

• Allow Spotlight to be customized (Try It disabled and logo) by @kichetof in https://github.com/dedoc/scramble/pull/177
• Added support of getRouteKeyName on a model by @romalytvynenko in https://github.com/dedoc/scramble/pull/208
• Added image and file validation rules support, request media type customization support by @WildEgo, @AlexSabur, @romalytvynenko in https://github.com/dedoc/scramble/pull/232

Fixes

• Fixed bug when @response wasn't the most prioritized by @romalytvynenko in https://github.com/dedoc/scramble/pull/205
• Fixed gibberish operationId when routes without names are cached by @romalytvynenko in https://github.com/dedoc/scramble/pull/207

New Contributors

• @kichetof made their first contribution in https://github.com/dedoc/scramble/pull/177
• @WildEgo made their first contribution in https://github.com/dedoc/scramble/pull/222

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.3...v0.8.4

What's Changed

• Fixed error when analyzing files with CR lines separator by @romalytvynenko in https://github.com/dedoc/scramble/pull/175
• Added support of models to LengthAwarePaginator annotation (LengthAwarePaginator<Post>) by @romalytvynenko in https://github.com/dedoc/scramble/pull/175

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.2...v0.8.3

What's Changed

• Fixed Scope@getType returning unexpected null by @romalytvynenko in https://github.com/dedoc/scramble/pull/167

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.1...v0.8.2

What's Changed

• Fixed exception when some of timestamps columns were null by @romalytvynenko in https://github.com/dedoc/scramble/pull/165

Full Changelog: https://github.com/dedoc/scramble/compare/v0.8.0...v0.8.1

What's Changed

🚨 Breaking changes 🚨

• Minimum PHP version is changed from 7.4 to 8.1. 96.4% of all the installs are coming from 8.1 and upper, so it's time to make this bump.
• Extensions API changes - internal type inference system got a huge rework, so I needed to update the extensions API to reflect that.

Added

• Lazy type inference for more accurate return types analysis by @romalytvynenko in https://github.com/dedoc/scramble/pull/138
• Added support of UUID model keys by @romalytvynenko in https://github.com/dedoc/scramble/pull/122
• Added confirmed rule support by @romalytvynenko in https://github.com/dedoc/scramble/pull/124
• Add operationId support by @romalytvynenko and @HelgeSverre in https://github.com/dedoc/scramble/pull/153

Changes

• Manually documented string unions become enum of a string in docs by @romalytvynenko in https://github.com/dedoc/scramble/pull/137
• Sort operations and schemas alphabetically by @romalytvynenko in https://github.com/dedoc/scramble/pull/152

Fixes

• Fixed spread operator not being properly analyzed when inferring a type for an array by @romalytvynenko in https://github.com/dedoc/scramble/pull/123

Full Changelog: https://github.com/dedoc/scramble/compare/v0.7.2...v0.8.0

What's Changed

• Added Laravel 10 support by @AlexSabur in https://github.com/dedoc/scramble/pull/109

New Contributors

• @AlexSabur made their first contribution in https://github.com/dedoc/scramble/pull/109

Full Changelog: https://github.com/dedoc/scramble/compare/v0.7.1...v0.7.2

What's Changed

• Specify how env auth works by @tontonsb in https://github.com/dedoc/scramble/pull/101
• Access to docs in local env only by default and using viewApiDocs gate in other environments by @tontonsb in https://github.com/dedoc/scramble/pull/102
• Added articles by @timschwartz in https://github.com/dedoc/scramble/pull/105
• Fixed error when declare(strict_types=1); was used by @romalytvynenko in https://github.com/dedoc/scramble/pull/107

New Contributors

• @tontonsb made their first contribution in https://github.com/dedoc/scramble/pull/101
• @timschwartz made their first contribution in https://github.com/dedoc/scramble/pull/105

Full Changelog: https://github.com/dedoc/scramble/compare/v0.7.0...v0.7.1

What's Changed

• Added server variables support, added multiple servers support by @romalytvynenko in https://github.com/dedoc/scramble/pull/76
• Added an ability to document request body params (in validation rules): allowed overriding resulting type, adding description, and example by @romalytvynenko in https://github.com/dedoc/scramble/pull/88
• Added abort helpers support (abort, abort_if, abort_unless) by @romalytvynenko in https://github.com/dedoc/scramble/pull/94
• Improved support of other JsonResources in the resource class, added support of 3rd argument in when and whenLoaded by @romalytvynenko in https://github.com/dedoc/scramble/pull/87
• Fixed an issue when references couldn't be marked as nullable by @romalytvynenko in https://github.com/dedoc/scramble/pull/74
• Fixed fatal error when an array item was manually documented without @var by @romalytvynenko in https://github.com/dedoc/scramble/pull/75
• Fixed exception caused by incorrect class const fetch on variables and other expressions handling by @romalytvynenko in https://github.com/dedoc/scramble/pull/86
• Improve array validation rule and falsy examples support by @romalytvynenko in https://github.com/dedoc/scramble/pull/89
• Fixed an access to exceptions property on possibly nullable object by @romalytvynenko in https://github.com/dedoc/scramble/pull/95
• Fix missing phpDoc attributes on resolved type attached by PhpDocHandler when they're attached to pending type by @romalytvynenko in https://github.com/dedoc/scramble/pull/96
• Fixed an exception when doctrine/dbal is not installed by @romalytvynenko in https://github.com/dedoc/scramble/pull/99

Full Changelog: https://github.com/dedoc/scramble/compare/v0.6.0...v0.7.0

What's Changed

• Added support of responsable exceptions as responses (403, 422, 404) by @romalytvynenko in https://github.com/dedoc/scramble/pull/65
• Added resource collections support by @romalytvynenko in https://github.com/dedoc/scramble/pull/64
• Added support for true and false expressions by @romalytvynenko in https://github.com/dedoc/scramble/pull/58
• Added literals support to PHPDoc types by @romalytvynenko in https://github.com/dedoc/scramble/pull/59
• Fixed an error that happened when combining responses with empty body and the same status by @romalytvynenko in https://github.com/dedoc/scramble/pull/60
• Fixed flawed path param aliasing to the var name by @romalytvynenko in https://github.com/dedoc/scramble/pull/63

Full Changelog: https://github.com/dedoc/scramble/compare/v0.5.0...v0.6.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: https://github.com/dedoc/scramble/compare/v0.4.0...v0.5.0