Releases

What’s Changed

• Fixed filter parameters becoming nested if dot used in a name

What’s Changed

• Improved exception message when normalizing data type

What’s Changed

• Fix constructor called methods side effects overwriting the type by @romalytvynenko in #740

What’s Changed

• Fixed default parameters extractors for different API versions by @romalytvynenko in #728

What’s Changed

• Added security implementation according OpenAPI 3.1.0 specification by @romalytvynenko in #717
• Fixed #[PathParameter] to override inferred path parameters by @romalytvynenko in #724
• Documenting CarbonInterface as date-time string schema by @axelrindle in #700
• Added support for Symfony\Component\HttpKernel\Exception\* documentation when annotated in exceptions by @phpsa in #674
• Added date rule support by @romalytvynenko in #725

New Contributors

• @phpsa made their first contribution in #674

What’s Changed

• Fix arrays unpacking in arrays passed to ->allow*(...) methods of query builder

What’s Changed

• Static and new calls analysis on literal string class name types coming from expressions by @romalytvynenko in #711
• Fixed deprecation warning on 8.4 by @romalytvynenko in #712
• Add null, true, false support when creating types from type nodes by @leo108 in #708

New Contributors

• @leo108 made their first contribution in #708

What’s Changed

• Fix when creating array types from values by @romalytvynenko in #707

What’s Changed

• Added ability to explicitly name schemas
• timacdonald/json-api support (simple features) by @romalytvynenko in #40
• Bump Scramble to 0.12.x by @romalytvynenko in #41

What’s Changed

• Fixed non-closure document transformers being not applied by @romalytvynenko
• Allow custom ExceptionToResponseExtension to override defaults by @ferdinandfrank in #699

New Contributors

• @ferdinandfrank made their first contribution in #699

What’s Changed

• Fixed not being able to register different transformers for different API versions by @romalytvynenko in #706

What’s Changed

• Ensure backward compatibility of ignoreDefaultRoutes method (it should be callable in register method of a service provider) by @romalytvynenko in #705

What’s Changed

• Fixed operations transformers has not been loaded by @romalytvynenko in #704

What’s Changed

Added

• Added ability to group and sort endpoints explicitly by #[Group] attribute. Changes the default ordering of endpoints to the order of their declaration by @romalytvynenko in #681
• Add ability to explicitly name class based schemas using #[SchemaName] attribute by @romalytvynenko in #682
• Added support for manually documenting request parameters using attributes #[QueryParameter], #[HeaderParameter], #[CookieParameter], #[PathParameter] by @romalytvynenko in
• Added #[BodyParameter] attribute support for documenting request body parameters by @romalytvynenko in #702https://github.com/dedoc/scramble
• Ensure consistent class names and avoid schema duplication. by @overtrue in #670
• Added self::* type inference support; added support of creating types from array values by @romalytvynenko in #687
• New configuration API (experimental) by @romalytvynenko in #696

🚨 Breaking changes 🚨

• TypeToSchema extensions and TypeTransformer cannot be created by the container just by passing the class name anymore. This is due to the TypeTransformer depending on Components class which is not global, but exists per API document.

This is very unlikely to affect you unless you developed the extensions and instantiated Scramble internal components yourself using the container and passing just the classname.

New Contributors

• @overtrue made their first contribution in #670

What’s Changed

• Bump Scramble dependency so the Collection is properly supported

What’s Changed

• Add operator and belongsTo filters documentation Laravel Query Builder support
• Improved Carbon type documentation, added @format support when used on data properties by @romalytvynenko in #36
• Support FromRouteParameters documentation on path parameters by @romalytvynenko in #37
• Fixed DataCollection type annotations not working correctly on data properties after the last update
• Deep checks for context aware data objects – now if any nested data property schema differs in input or output context, the containing data object will be properly documented for different contexts
• Improved #[Confirmed] support

What’s Changed

• Fixed data collections documentation (null check issue)

What’s Changed

• Fix analysis of data classes from vendor (other packages)

What’s Changed

• Added support of explicit data collections creation (using new)
• Add support of include and exclude on data collections by @romalytvynenko in #29