From db467dc2740405a7a5eb68a844660e269fa84573 Mon Sep 17 00:00:00 2001 From: Djordy Koert Date: Wed, 6 Mar 2024 19:36:52 +0100 Subject: [PATCH] Prepare 4.23.0 (#2238) * 4.23.0 changelog * add vendor extension to example --- CHANGELOG.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 1 + 2 files changed, 55 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3bdc49aa1..91c9cd11e 100644 --- a/CHANGELOG.md +++ b/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. diff --git a/docs/index.rst b/docs/index.rst index 42a1e49b0..c3c529699 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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: