NelmioApiDocBundle Versions Save

Generates documentation for your REST API from annotations

v4.26.1

4 weeks ago

What's Changed

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.26.0...v4.26.1

v4.26.0

1 month ago

What's Changed

New Contributors

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/4.25.3...v4.26.0

4.25.3

1 month ago

What's Changed

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/4.25.2...4.25.3

4.25.2

1 month ago

What's Changed

New Contributors

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.25.1...4.25.2

v4.25.1

1 month ago

What's Changed

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.25.0...v4.25.1

v4.25.0

1 month ago

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

New Contributors

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.24.1...v4.25.0

v4.24.1

1 month ago

Changes

v4.24.0

2 months ago

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

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.23.1...v4.24.0

v4.23.1

2 months ago

What's Changed

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.23.0...v4.23.1

v4.23.0

2 months ago

Changelog

  • Cache configuration option nelmio_api_doc.cache.item_id now automatically gets the area appended. 
    nelmio_api_doc:
    cache:
        pool: app.cache
        item_id: nelmio_api_doc.docs
    areas:
        default: 
            ...
        area1:   
            ...
    Result in cache keys: nelmio_api_doc.docs.default & nelmio_api_doc.docs.area1 to be used respectively.
  • Added cache configuration option per area. 
    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
            ...
    Non-configured options will be inherited from nelmio_api_doc.cache.
  • Fixed vendor extensions (x-*) from configuration not being outputted in the generated specification. 
    nelmio_api_doc:
    documentation:
        info:
            title: 'My API'
            description: 'My API description'
            x-foo: 'bar'
    Now results in JSON specification: 
    {
  ...
  "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 of allOf.

What's Changed

New Contributors

Full Changelog: https://github.com/nelmio/NelmioApiDocBundle/compare/v4.22.1...v4.23.0