Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare 4.23.0 #2238

Merged
merged 2 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
54 changes: 54 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
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