Releases: nelmio/NelmioApiDocBundle
v4.25.1
What's Changed
- Install & run PHP-CS-Fixer by @DominicLuidold in #2250
Full Changelog: v4.25.0...v4.25.1
v4.25.0
Changelog
- Added support for JMS @Discriminator annotation/attribute
#[\JMS\Serializer\Annotation\Discriminator(field: 'type', map: ['car' => Car::class, 'plane' => Plane::class])] abstract class Vehicle { } class Car extends Vehicle { } class Plane extends Vehicle { }
What's Changed
- fix(#2222): Fix properties with default values getting marked as required by @DominicLuidold in #2248
- Support for JMS discriminator map by @BesedinSasha in #2247
New Contributors
- @DominicLuidold made their first contribution in #2248
- @BesedinSasha made their first contribution in #2247
Full Changelog: v4.24.1...v4.25.0
v4.24.1
Changes
- Added conflict for swagger-php 4.8.7, see issue zircote/swagger-php#1562
v4.24.0
Changelog
Added support for some integer ranges (https://phpstan.org/writing-php-code/phpdoc-types#integer-ranges).
Annotations attached to integer properties like:
/**
* @var int<6, 11>
* @var int<min, 11>
* @var int<6, max>
* @var positive-int
* @var negative-int
*/
will be interpreted as appropriate minimum and maximum properties in the generated OpenAPI specification.
Minor breaking change
Dropped support for PHP 7.2 and PHP 7.3. PHP 7.4 is the minimum required version now.
What's Changed
- Update .symfony.bundle.yaml by @javiereguiluz in #2241
- Issue templates by @DjordyKoert in #2242
- Support for range integers + drop support for PHP 7.2 & 7.3 by @bnowak in #2236
Full Changelog: v4.23.1...v4.24.0
v4.23.1
What's Changed
- fix: use iterable check instead of array by @DjordyKoert in #2239
Full Changelog: v4.23.0...v4.23.1
v4.23.0
Changelog
- Cache configuration option
nelmio_api_doc.cache.item_id
now automatically gets the area appended.Result in cache keys:nelmio_api_doc: cache: pool: app.cache item_id: nelmio_api_doc.docs areas: default: ... area1: ...
nelmio_api_doc.docs.default
&nelmio_api_doc.docs.area1
to be used respectively. - Added cache configuration option per area.
Non-configured options will be inherited from
nelmio_api_doc: areas: default: # Manual cache configuration cache: pool: app.cache item_id: nelmio_api_doc.docs.default ... area1: cache: pool: app.cache item_id: nelmio_api_doc.docs.area1 ...
nelmio_api_doc.cache
. - Fixed vendor extensions (
x-*
) from configuration not being outputted in the generated specification.Now results in JSON specification:nelmio_api_doc: documentation: info: title: 'My API' description: 'My API description' x-foo: 'bar'
{ ... "info": { "title": "API", "version": "1.0", "x-foo": "bar" }, ... }
- Updated nullable enum handling to align with the behaviour of other object types. It now uses wraps nullable enums with
oneOf
instead ofallOf
.
What's Changed
- fix: invalid nullable enums with OAS 3.1 version by @bnowak in #2226
- Fix for using cache pools with multiple areas by @Brajk19 in #2232
- fix-2224: fix vendor extension being ignored by @DjordyKoert in #2230
- Prepare 4.23.0 by @DjordyKoert in #2238
New Contributors
Full Changelog: v4.22.1...v4.23.0
v4.22.1
What's Changed
- update .gitattributes for new directory structure by @DjordyKoert in #2229
Full Changelog: v4.22.0...v4.22.1
v4.22.0
Changelog
-
Updated bundle directory structure to recommended file structure as described in https://symfony.com/doc/7.0/bundles/best_practices.html.
It might be necessary to reinstall the assets:
bin/console assets:install
What's Changed
- Update bundle directory structure by @DjordyKoert in #2228
Full Changelog: v4.21.0...v4.22.0
v4.21.0
v4.20.0
Changelog
- Added Redocly as an alternative to Swagger UI. https://github.com/Redocly/redoc.
- Added support for describing dictionary types in OpenAPI 3.0.
What's Changed
- Add support for redocly by @Gabb1995 in #2066
- feat-2207: Implement property describer for dictionary by @DjordyKoert in #2208
New Contributors
Full Changelog: v4.19.3...v4.20.0