Merge branch 'master' into 5.x

# Conflicts: # docs/configuration_reference.rst # src/DependencyInjection/Configuration.php # src/DependencyInjection/NelmioApiDocExtension.php # src/Routing/FilteredRouteCollectionBuilder.php # tests/DependencyInjection/ConfigurationTest.php # tests/Routing/FilteredRouteCollectionBuilderTest.php
nelmio · Jan 19, 2025 · d25519f · d25519f
2 parents 2018907 + 3aaa734
commit d25519f
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 9 deletions.
diff --git a/.doctor-rst.yaml b/.doctor-rst.yaml
@@ -53,16 +53,16 @@ rules:
 
     #   master
     versionadded_directive_major_version:
-        major_version: 7
+        major_version: 4
 
     versionadded_directive_min_version:
-        min_version: '7.0'
+        min_version: '4.0'
 
     deprecated_directive_major_version:
-        major_version: 6
+        major_version: 4
 
     deprecated_directive_min_version:
-        min_version: '6.0'
+        min_version: '4.0'
 
 # do not report as violation
 whitelist:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 4.36.0
+* Configuration option `with_annotation` has been deprecated in favor of `with_attribute`
+```diff
+nelmio_api_doc:
+    areas:
+        path_patterns:
+            - ^/api/foo
+-       with_annotation: true
++       with_attribute: true
+```
+
 ## 4.35.0
 * Added support for the symfony/type-info component
 ```yaml

diff --git a/config/services.xml b/config/services.xml
@@ -163,7 +163,7 @@
 
         <!-- Type describers (symfony/type-info) -->
         <service id="nelmio_api_doc.type_describer.chain" class="Nelmio\ApiDocBundle\TypeDescriber\ChainDescriber" public="false">
-            <argument type="tagged" tag="nelmio_api_doc.type_describer" />
+            <argument type="tagged_iterator" tag="nelmio_api_doc.type_describer" />
 
             <tag name="nelmio_api_doc.type_describer" priority="1000" />
         </service>

diff --git a/docs/configuration_reference.rst b/docs/configuration_reference.rst
@@ -54,7 +54,7 @@ The bundle configuration is stored under the ``nelmio_api_doc`` key in your appl
                     # Example:
                     # - ^api_v1
             # whether to filter by attributes
-            with_attribute:       false
+            with_attribute: false
             # if set disables default routes without attributes
             disable_default_routes: false
             # The base documentation used for the area
@@ -94,6 +94,10 @@ Whether to use `symfony/type-info`_ for determining types.
 
     If you are using Symfony 7.2 or higher, you should set this option to ``true``. As this greatly improves type detection.
 
+.. versionadded:: 4.35
+
+    Support for `symfony/type-info`_ was added in 4.35.
+
 use_validation_groups
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -193,7 +197,7 @@ Filter the routes that are documented.
                     name_patterns:
                         # Example:
                         # - ^api_v1
-                with_attribute:       false
+                with_attribute: false
                 disable_default_routes: false
                 documentation:
                     # Example:

diff --git a/docs/faq.rst b/docs/faq.rst
@@ -250,7 +250,7 @@ Q: I have a property that is not recognized. How can I specify the type?
             type_info: true
             # ...
 
-.. versionadded:: 7.2
+.. versionadded:: 4.35
 
     The `TypeInfo component`_ was introduced as a stable feature in Symfony 7.2.
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -413,7 +413,7 @@ General PHP objects
             type_info: true
             # ...
 
-.. versionadded:: 7.2
+.. versionadded:: 4.35
 
     The `TypeInfo component`_ was introduced as a stable feature in Symfony 7.2.