Skip to content

Latest commit

 

History

History
100 lines (76 loc) · 2.64 KB

CHANGELOG.md

File metadata and controls

100 lines (76 loc) · 2.64 KB

CHANGELOG

4.0.0

  • Added support of OpenAPI 3.0. The internals were completely reworked and this version introduces BC breaks.

3.7.0

  • Added @SerializedName annotation support and name converters when using Symfony >= 4.2.
  • Removed pattern added from the Expression Violation message.
  • Added FOSRestBundle 3.x support
  • Added @SWG annotations support at methods level in models

3.3.0

3.2.0 (2018-03-24)

  • Add a documentation form extension. Use the documentation option to define how a form field is documented.

  • Allow references to config definitions in controllers.

  • Using @Model implicitely in @SWG\Schema, @SWG\Items and @SWG\Property is deprecated. Use ref=@Model() instead.

    Before:

    /**
     * This was considered as an array of models.
     *
     * @SWG\Property(@Model(type=FooClass::class))
     */

    After:

    /**
     * For an individual object:
     * @SWG\Property(ref=@Model(type=FooClass::class))
     *
     * For an array:
     * @SWG\Property(type="array", @SWG\Items(ref=@Model(type=FooClass::class)))
     */

Config

  • nelmio_api_doc.areas added support to filter by host patterns.

    nelmio_api_doc:
        areas: [ host_patterns: [ ^api\. ] ]
  • Added dependency for "symfony/options-resolver:^3.4.4|^4.0"

3.1.0 (2018-01-28)

  • Added Symfony Validator constraints support

Symfony Forms

  • Support for boolean checkbox
  • Support for integer

JMS Serializer

  • Support JMS int (alias for integer)
  • Also process phpdoc annotations

SwaggerPHP

  • Handle enum and default properties from SwaggerPHP annotation
  • Support @Security annotations

Config

  • nelmio_api_doc.routes has been replaced by nelmio_api_doc.areas. Please update your config accordingly.

    Before:

    nelmio_api_doc:
        routes: [ path_patterns: [ /api ] ]

    After:

    nelmio_api_doc:
        areas: [ path_patterns: [ /api ] ]

3.0.0 (2017-12-10)

Large refactoring introducing zircote/swagger-php for swagger annotations.

See UPGRADE-3.0.md for upgrading instructions.