mirror of
https://github.com/retailcrm/NelmioApiDocBundle.git
synced 2025-02-02 15:51:48 +03:00
c771c684a8
* Allow to override certain parts of the template * Twig template can be defined via config * Blocks can be used to override/extend only parts of the template * Fix spelling in documentation * Fix extension configuration tree * Fix unit tests by making constructor argument optional * Add fonts block and split swagger initialization into own block * Fix code style * Remove Google fonts, remove configuration and add changelog entry * Remove template argument from service definition * Add correct path for overriding template * Move re-add of Google Fonts to FAQ section in documentation. * Remove unused class import
89 lines
2.3 KiB
Markdown
89 lines
2.3 KiB
Markdown
CHANGELOG
|
|
=========
|
|
|
|
3.3.0 (unreleased)
|
|
------------------
|
|
|
|
* Usage of Google Fonts was removed. System fonts `serif` / `sans` will be used instead.
|
|
This can lead to a different look on different operating systems.
|
|
You can [re-add Google Fonts again manually by overriding the template](https://symfony.com/doc/current/bundles/NelmioApiDocBundle/faq.html#re-add-google-fonts).
|
|
|
|
* The Twig template for the Swagger UI now contains blocks to make it easier to overwrite certain parts.
|
|
See the [official documentation](https://symfony.com/doc/current/bundles/NelmioApiDocBundle/customization.html) how to do this.
|
|
|
|
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:
|
|
```php
|
|
/**
|
|
* This was considered as an array of models.
|
|
*
|
|
* @SWG\Property(@Model(type=FooClass::class))
|
|
*/
|
|
```
|
|
|
|
After:
|
|
```php
|
|
/**
|
|
* 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.
|
|
|
|
```yml
|
|
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:
|
|
```yml
|
|
nelmio_api_doc:
|
|
routes: [ path_patterns: [ /api ] ]
|
|
```
|
|
|
|
After:
|
|
```yml
|
|
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.
|