Releases

What’s Changed

• Documenting when request body is required if some property is required

What’s Changed

• Added proper mixed type support by @romalytvynenko in #579
• Added required field support to request body as well as automatically documenting it when some fields in schema required by @romalytvynenko in #580

What’s Changed

• Ability to use paginators as a part of other schemas by @romalytvynenko in #574
• Add file upload in OAS 3.1 format description support by @yvoitenko in #569
• Fixed incorrect parsing of inline JSON resource model annotating comments by @romalytvynenko in #575
• Added immutable_date casts support by @romalytvynenko in #576
• Fix failing when fetching constants using variables by @romalytvynenko in #577

New Contributors

• @yvoitenko made their first contribution in #569

What’s Changed

• Added support for documenting included or excluded Lazy properties of Laravel Data objects. Now when you use include/exclude methods on Laravel Data object, Scramble will correctly get the resulting type. Calling defaultIncluded method on Lazy property is also now correctly documented.
• When creating Laravel Data objects using from method and passing a model, Scramble will now correctly infer the type from fromModel method.

What’s Changed

• Add support for all pagination classes by @romalytvynenko in #565
• Fix the extensions ordering so users extensions’ result is not overwritten by @romalytvynenko in #570

What’s changed

• Fixed annotated collections won’t documented properly when using the Data object as an input.

What’s changed

• int property types are now correctly documented as integer schema

What’s changed

• Laravel Data: improved @example support when specifying numeric examples for string properties.

What’s Changed

• Correctly handle a case when both form request and inline validation used by @romalytvynenko in #552

What’s changed

• Fixed MapInputName issue: previously defining it would affect schema properties names when used as a response: this should not happen.
• Bump Scramble dependency to 0.11.15

What’s Changed

• Using decodeURIComponent instead of decodeURI to better support Sanctum CSRF by @ritenn in #548
• Added @default support to JSON API resources by @romalytvynenko in #549
• Avoid documenting empty request body by @romalytvynenko in #550
• Fixed incorrect data wrap key when using AnonymousResourceCollection and redefining it in collected resource by @axelrindle in #517

New Contributors

• @ritenn made their first contribution in #548
• @axelrindle made their first contribution in #517

What’s changed

Scramble was bumped to ^0.11.14.

This fixes the issue when Query Builder used in a controller’s method after a method where it was used with a different set of constraints, the constraints was bleeding into other method’s documentation.

What’s Changed

• Fixes possible undefined array index 0 due to array_filter() by @kburton-dev in #530
• Fixed accidentally mutating types when working with types by @romalytvynenko in #546

What’s Changed

• Fixed Scramble mutating return type if it has templates in it by @romalytvynenko in #524

What’s Changed

• Validation parsing: ignore required on sometimes rule by @lakuapik in #492
• Add parent::toArray support for JSON API resources by @romalytvynenko in #506
• Add withResponse support for JSON API resources by @romalytvynenko in #514
• Fixed return type inference from models when in JSON API resource context by @romalytvynenko in #516

New Contributors

• @lakuapik made their first contribution in #492

What’s Changed

• Fix anyOf being output as an object if some response type gets filtered out by @dmitrijs in #486
• Lock Stoplight Elements to 8.3.4 to fix styles of request body by @romalytvynenko in #487

New Contributors

• @dmitrijs made their first contribution in #486

What’s Changed

• Match namespace|use only on begining of line by @gjm in #477

New Contributors

• @gjm made their first contribution in #477

What’s Changed

• Fixed an issue when it wasn’t possible to describe the array item’s shape using validation rules
• Added proper handling of union types when used as property type hint by @romalytvynenko in #14

What’s changed

• Fixed an error when retrieving property on a model that cannot be instantiated

What’s Changed

• Fix the ability to inject query builder, and potentially faulty index bag