Skip to content

Commit

Permalink
Prepare 4.23.0 (#2238)
Browse files Browse the repository at this point in the history
* 4.23.0 changelog

* add vendor extension to example
  • Loading branch information
DjordyKoert committed Mar 6, 2024
1 parent beb544e commit db467dc
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
54 changes: 54 additions & 0 deletions CHANGELOG.md
@@ -1,6 +1,60 @@
CHANGELOG
=========

4.23.0
-----
* Cache configuration option `nelmio_api_doc.cache.item_id` now automatically gets the area appended.
```yml
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.
```yml
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.
```yml
nelmio_api_doc:
documentation:
info:
title: 'My API'
description: 'My API description'
x-foo: 'bar'
```
Now results in JSON specification:
```json
{
...
"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`.

4.22.0
-----
* Updated bundle directory structure to recommended file structure as described in https://symfony.com/doc/7.0/bundles/best_practices.html.
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -130,6 +130,7 @@ You can configure global information in the bundle configuration ``documentation
title: My App
description: This is an awesome app!
version: 1.0.0
x-build: #CommitHash
components:
securitySchemes:
Bearer:
Expand Down

0 comments on commit db467dc

Please sign in to comment.