Scramble Laravel Package

What's Changed

• Improve JSON schema examples: add multiple [@example](https://github.com/example) support, avoid using example (deprecated, using examples instead) when serializing JSON schemas by @romalytvynenko in https://github.com/dedoc/scramble/pull/1205
• Improve Laravel 10.x compatibility for paginators

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.31...v0.13.32

What's Changed

• Add support for Laravel's fluent File validation rule by @squiaios in https://github.com/dedoc/scramble/pull/1185
• Improve nullable enum rule and serialization support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1195
• Prevent more PHP 8.5 deprecations by @romalytvynenko in https://github.com/dedoc/scramble/pull/1196
• Adds support for accepted rule by @cappuc in https://github.com/dedoc/scramble/pull/1129
• Add support for extending the Group attribute by @sanfair in https://github.com/dedoc/scramble/pull/1201
• Add nullsafe operator support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1203
• Fix coalesce operator support on property fetch by @romalytvynenko in https://github.com/dedoc/scramble/pull/1204

New Contributors

• @squiaios made their first contribution in https://github.com/dedoc/scramble/pull/1185
• @sanfair made their first contribution in https://github.com/dedoc/scramble/pull/1201

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.30...v0.13.31

What's Changed

• Update paginator's toArray logic so the type is coming from the real method
• Added except and only support (for models and Arr helpers) by @romalytvynenko in https://github.com/dedoc/scramble/pull/1193
• Fixed JSON API resources when consts are used for attributes and relations properties by @romalytvynenko in https://github.com/dedoc/scramble/pull/1194
• Add support for pagination from Scout query builder by @cappuc in https://github.com/dedoc/scramble/pull/1190

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.29...v0.13.30

What's Changed

• Fix config inconsistency

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.28...v0.13.29

What's Changed

• Fix pre-serialized class map (failed in some cases due to new data on property definition)

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.27...v0.13.28

What's Changed

• Silence some PHP 8.5 deprecations (null array offset, preg_replace null) by @dabrandstetter in https://github.com/dedoc/scramble/pull/1155
• Add ability to cache OpenAPI document by @romalytvynenko in https://github.com/dedoc/scramble/pull/1178
• Plain objects documnetation by @romalytvynenko in https://github.com/dedoc/scramble/pull/1181

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.26...v0.13.27

What's Changed

• Fix missing Reference type during parameters serialization by @romalytvynenko in https://github.com/dedoc/scramble/pull/1177

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.25...v0.13.26

What's Changed

• Add #[IgnoreParam] attribute support by @WendellAdriel in https://github.com/dedoc/scramble/pull/1176
• Add UI renderers support (Scalar, etc.) by @romalytvynenko in https://github.com/dedoc/scramble/pull/1175

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.24...v0.13.25

What's Changed

• Improve inference: __ support, facades support, array destructuring support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1167 and https://github.com/dedoc/scramble/pull/1172
• Add include/exclude filtering to scramble.api_path by @romalytvynenko in https://github.com/dedoc/scramble/pull/1168
• Automatically document API authentication by @romalytvynenko in https://github.com/dedoc/scramble/pull/1170
• Improve inference by dropping type of calls to non-existing methods in unions in https://github.com/dedoc/scramble/pull/1171
• Added newCollection support on models by @romalytvynenko in https://github.com/dedoc/scramble/pull/1171
• Add Responsable support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1173

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.23...v0.13.24

What's Changed

• Support real-time Facades by @jcsoriano in https://github.com/dedoc/scramble/pull/1146
• Support type inference for method calls and property access on union types by @romalytvynenko in https://github.com/dedoc/scramble/pull/1151
• Improve null coalescing operator inference by @romalytvynenko in https://github.com/dedoc/scramble/pull/1152
• Improve performance for projects with many inline types by @romalytvynenko in https://github.com/dedoc/scramble/pull/1163

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.22...v0.13.23

What's Changed

• Support custom field for confirmed rule by @cappuc in https://github.com/dedoc/scramble/pull/1128
• Add support for $this in rule expressions and improve rules evaluation safety by @romalytvynenko in https://github.com/dedoc/scramble/pull/1145

Security: addresses a potential code execution issue under specific conditions.

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.21...v0.13.22

What's Changed

• Fix relationship resource guessing when not explicitly provided and recognize JSON:API parameters when resource is transformed to response by @romalytvynenko in https://github.com/dedoc/scramble/pull/1143

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.20...v0.13.21

What's Changed

• Add toResourceCollection support on paginators by @romalytvynenko in https://github.com/dedoc/scramble/pull/1142

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.19...v0.13.20

What's Changed

• Add JSON:API resources support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1136
• Add model's toResource and toResourceCollection methods support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1138
• Add attributes support on FormRequest (e.g. #[*Parameter], #[SchemaName]) by @romalytvynenko in https://github.com/dedoc/scramble/pull/1141
• Fix variadic placeholder request inference error by @romalytvynenko in https://github.com/dedoc/scramble/pull/1139

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.18...v0.13.19

What's Changed

• Fix memory leak in long-running processes (prevent extensions priority duplication) by @romalytvynenko in https://github.com/dedoc/scramble/pull/1132

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.17...v0.13.18

What's Changed

• Improved type templates inference by @romalytvynenko in https://github.com/dedoc/scramble/pull/1112
• Improve type inference so when (from Conditional trait) is supported by @romalytvynenko in https://github.com/dedoc/scramble/pull/1113
• Soft delete methods support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1117
• Fix #[SchemaName] attribute not reflected in response description by @dbrekelmans in https://github.com/dedoc/scramble/pull/1118
• Fix required rule on arrays not setting minItems: 1 by @dbrekelmans in https://github.com/dedoc/scramble/pull/1120
• Fix enum placed on array instead of items in OpenAPI spec by @dbrekelmans in https://github.com/dedoc/scramble/pull/1119

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.16...v0.13.17

What's Changed

• Smarter inference for paginate calls on models and query builders by @romalytvynenko in https://github.com/dedoc/scramble/pull/1109
• Support more string types by @Neol3108 in https://github.com/dedoc/scramble/pull/1110
• Add [@phpstan-self-out](https://github.com/phpstan-self-out) support and improve closure param inference from call-site context by @romalytvynenko in https://github.com/dedoc/scramble/pull/1111

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.15...v0.13.16

What's Changed

• Improve rules evaluation by @romalytvynenko in https://github.com/dedoc/scramble/pull/1097
• Laravel 13.x Compatibility by @laravel-shift in https://github.com/dedoc/scramble/pull/1099
• Added [@hidden](https://github.com/hidden) annotation and attribute by @romalytvynenko in https://github.com/dedoc/scramble/pull/1106
• Fix nullable literal unions missing null in enum property by @romalytvynenko in https://github.com/dedoc/scramble/pull/1107
• Fix #[QueryParameter] with nested brackets (and other parameters attributes) generates incorrect parameter name by @romalytvynenko in https://github.com/dedoc/scramble/pull/1108

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.14...v0.13.15

What's Changed

• Fixed evaluation of class const fetch expression when name is 'class' by @romalytvynenko in https://github.com/dedoc/scramble/pull/1090
• Fixed model properties with datetime:Y-m-d cast being documented as date-time format (now correctly documented as date) by @romalytvynenko in https://github.com/dedoc/scramble/pull/1091
• Improve [@deprecated](https://github.com/deprecated) annotation support on arrays by @romalytvynenko in https://github.com/dedoc/scramble/pull/1093
• Fixed keyed array types being properly unpacked when are parts of union by @romalytvynenko in https://github.com/dedoc/scramble/pull/1094
• Constants as openapi const by @apasquini95 in https://github.com/dedoc/scramble/pull/1086

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.13...v0.13.14

What's Changed

• Added ability to configure classes ignored by form request params extractor by @romalytvynenko in https://github.com/dedoc/scramble/pull/1081
• Updated unions to schema transformation when union consists of literals with null by @romalytvynenko in https://github.com/dedoc/scramble/pull/1083
• Ensure request body extension takes into account manually configured flatten_deep_query_parameters by @romalytvynenko in https://github.com/dedoc/scramble/pull/1084
• Handle [@deprecated](https://github.com/deprecated) in API resources by @devfrey in https://github.com/dedoc/scramble/pull/1080
• Handle null value for ui.title in docs view. by @IsmailBourbie in https://github.com/dedoc/scramble/pull/1087

New Contributors

• @devfrey made their first contribution in https://github.com/dedoc/scramble/pull/1080
• @IsmailBourbie made their first contribution in https://github.com/dedoc/scramble/pull/1087

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.12...v0.13.13

What's Changed

• Fixed manually annotated NotFoundHttpException being not documented anymore by @romalytvynenko in https://github.com/dedoc/scramble/pull/1074
• Updated array type inference when assigning to empty dimension - now arrays are inferred, not tuples by @romalytvynenko in https://github.com/dedoc/scramble/pull/1079

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.11...v0.13.12

What's Changed

• Added flow sensitive analysis capabilities by @romalytvynenko in https://github.com/dedoc/scramble/pull/1069
• Fixed Enum rule handling after Laravel 12.48 made it stringable by @finalgamer in https://github.com/dedoc/scramble/pull/1066

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.10...v0.13.11

What's Changed

• Allow customizing which HTTP methods are documented for multi-method routes by @romalytvynenko in https://github.com/dedoc/scramble/pull/1052
• Added regex validation rule support by @romalytvynenko in https://github.com/dedoc/scramble/pull/1050
• Added evaluation of array keys when array keys can be statically evaluated by @romalytvynenko in https://github.com/dedoc/scramble/pull/1051
• Added title and description attributes to Endpoint attribute by @mikield in https://github.com/dedoc/scramble/pull/1007
• Fixed incorrect column type when using exists rule on UUID columns by @romalytvynenko in https://github.com/dedoc/scramble/pull/1049

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.9...v0.13.10

What's Changed

• Added support for [@deprecated](https://github.com/deprecated) annotation on fields by @romalytvynenko in https://github.com/dedoc/scramble/pull/1048

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.8...v0.13.9

What's Changed

• Improve nested required parameters handling by @romalytvynenko in https://github.com/dedoc/scramble/pull/1042

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.7...v0.13.8

What's Changed

• Reduce arrayable schema extension priority by @romalytvynenko in https://github.com/dedoc/scramble/pull/1039

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.6...v0.13.7

What's Changed

• Fixed exception extensions cannot be overridden by @romalytvynenko in https://github.com/dedoc/scramble/pull/1034
• Fix trailing comma issue when analyzing properties by @romalytvynenko in https://github.com/dedoc/scramble/pull/1035
• Improve union type handling

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.5...v0.13.6

What's Changed

• Fixes analysis of variables with expression names (caused "Variable could not be converted to string scope exception") by @romalytvynenko in https://github.com/dedoc/scramble/pull/1030
• Fixed array unwrapping by @romalytvynenko in https://github.com/dedoc/scramble/pull/1031
• Fixed models documentation and union annotations

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.4...v0.13.5

What's Changed

• Support for classes which implement Arrayable interface by @klAvAx in https://github.com/dedoc/scramble/pull/1012
• Fix invalid handling of controller's annotated union type by @romalytvynenko in https://github.com/dedoc/scramble/pull/1020

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.3...v0.13.4

🚨 Breaking changes

While unlikely this is going to affect you, RulesToParameter class has been removed. It was the internal not documented class, so it wasn't intended to be used on its own. Due to the low possibility of this affecting someone, I'm not tagging a new 0.14.x release.

What's Changed

• Rules documentation API by @romalytvynenko in https://github.com/dedoc/scramble/pull/1016
• Use IntegerRangeType for pagination schema fields by @hosni in https://github.com/dedoc/scramble/pull/1018
• Fix recursive self out by @romalytvynenko in https://github.com/dedoc/scramble/pull/1019

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.2...v0.13.3

What's Changed

• Added support of variables used in validation rules by @chaikivskyi in https://github.com/dedoc/scramble/pull/1005
• Fixed isInstanceOf could've returned null for template type.
• Fixed infinite recursion for cases when [@mixin](https://github.com/mixin) of the class alias is used on the same class 😵‍💫

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.1...v0.13.2

What's Changed

• Expose more internal type inference related APIs by @romalytvynenko in https://github.com/dedoc/scramble/pull/1006

Full Changelog: https://github.com/dedoc/scramble/compare/v0.13.0...v0.13.1

While this release has no breaking changes itself, the resulting OpenAPI document may be more accurate for your specific application, and hence may be considered as the one containing breaking changes. Due to this, I've decided to mark this release as 0.13.x. It means that you'll need to explicitly update the version in composer.json if you rely on ^0.12.0 or earlier versions.

Full type inference

Starting from Laravel 11.x (and especially from 12.x), Laravel comes with great and accurate PHPDoc annotations. With Scramble supporting these types, you'll enjoy focusing more on the app codebase rather than writing type annotations.

use App\Models\Appointment;

Route::get('/appointments', function (Request $request) {
    $items = Appointment::query()
        ->where('status', $request->string('status'))
        ->get();

    return $items;
});

In this case, Scramble can infer the type of $items: it is a collection of appointments, specifically: Illuminate\Database\Eloquent\Collection<int, App\Models\Appointment>!

This gives nice documentation just by analyzing the source, without any additional annotations.

Closure-based routes support

Previously, Scramble only supported controller-based routes. Now, the routes defined using closures also get their share of love and are documented automatically.

Closure-based routes support all the attributes (for manual parameters, headers, responses, etc.) that are supported by controller-based methods.

What's Changed

• Add closure routes support by @romalytvynenko in https://github.com/dedoc/scramble/pull/971
• Infer null coalescing operator by @jrdnrc in https://github.com/dedoc/scramble/pull/980
• Added analysis of types coming from PHPDoc annotations in vendor by @romalytvynenko in https://github.com/dedoc/scramble/pull/988
• Support more integer types by @Neol3108 in https://github.com/dedoc/scramble/pull/996
• Add Request@user method support for better post-installation experience by @romalytvynenko in https://github.com/dedoc/scramble/pull/1001

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.36...v0.13.0

What's Changed

• Added config for flattening query object parameters
• Replace api path only if it appears at the beginning
• Improve date_format rule documentation
• Added enum names extension property support
• Add support for wildcard array keys in validation rules

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.35...v0.12.36

What's Changed

• Remove MissingValue in combination with Carbon/ CarbonImmutable when transforming by @chrisvanlier2005 in https://github.com/dedoc/scramble/pull/960
• Add paginationInformation resource's method support by @romalytvynenko in https://github.com/dedoc/scramble/pull/962
• Add support for transforming @var list<T> by @chrisvanlier2005 in https://github.com/dedoc/scramble/pull/961
• Pin [@stoplight](https://github.com/stoplight)/elements to 8.4.2 to avoid tags duplication by @romalytvynenko in https://github.com/dedoc/scramble/pull/964
• Add unset support and provide $paginated type to paginationInformation by @romalytvynenko in https://github.com/dedoc/scramble/pull/968

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.34...v0.12.35

What's Changed

• Patch for Stoplight Elements UI dark mode 🫠 by @romalytvynenko in https://github.com/dedoc/scramble/pull/953

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.33...v0.12.34

What's Changed

• Added Rule::when support by @romalytvynenko in https://github.com/dedoc/scramble/pull/951

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.32...v0.12.33

What's Changed

• Add support operationId support via Endpoint attribute by @jrdnrc in https://github.com/dedoc/scramble/pull/941
• Fix throw statements showing as unknown "string" type in match expressions by @finalgamer in https://github.com/dedoc/scramble/pull/944
• Improve type template inference by @romalytvynenko in https://github.com/dedoc/scramble/pull/948
• Fix Rule::requiredIf treated as required by @apasquini95 in https://github.com/dedoc/scramble/pull/939

New Contributors

• @jrdnrc made their first contribution in https://github.com/dedoc/scramble/pull/941
• @finalgamer made their first contribution in https://github.com/dedoc/scramble/pull/944
• @apasquini95 made their first contribution in https://github.com/dedoc/scramble/pull/939

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.31...v0.12.32

What's Changed

• Improve API resources and resource collections inference and documentation by @romalytvynenko in https://github.com/dedoc/scramble/pull/937
• Add ability to configure inference (internal) by @romalytvynenko in https://github.com/dedoc/scramble/pull/940

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.30...v0.12.31

What's Changed

• Add support for transforming inferred paginator types by @romalytvynenko in https://github.com/dedoc/scramble/pull/931
• Add support for transforming response type with headers to schema and improve collection responses type to schema transformation by @romalytvynenko in https://github.com/dedoc/scramble/pull/932
• Add support for system color theme by @macbookandrew in https://github.com/dedoc/scramble/pull/923

New Contributors

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

Full Changelog: https://github.com/dedoc/scramble/compare/v0.12.29...v0.12.30