nelmio/api-doc-bundle

5.11.1 (2026-08-12)

Bug Fixes

• harden OpenAPI generation for FrankenPHP / long-lived workers (#2772) (7b8ab07)

Bug Fixes

• harden OpenAPI generation for FrankenPHP / long-lived workers (#2772) (7b8ab07)

5.11.0 (2026-08-03)

Features

• Add support for the query http method (#2732) (a46818f)

Bug Fixes

• deps: require zircote/swagger-php >= 5.7.8 for the query method (#2782) (1eef066)

Miscellaneous Chores

• deps: bump @scalar/api-reference from 1.57.5 to 1.62.5 in /utils (#2769) (cabb52e)
• deps: bump @scalar/api-reference from 1.62.5 to 1.64.0 in /utils (#2780) (e2b085c)
• deps: bump @stoplight/elements from 9.0.21 to 9.0.24 in /utils (#2774) (c8f3e4e)
• deps: bump swagger-ui-dist from 5.32.6 to 5.32.11 in /utils (#2777) (9654f06)

Features

• Add support for the query http method (#2732) (a46818f)

Bug Fixes

• deps: require zircote/swagger-php >= 5.7.8 for the query method (#2782) (1eef066)

Miscellaneous Chores

• deps: bump @scalar/api-reference from 1.57.5 to 1.62.5 in /utils (#2769) (cabb52e)
• deps: bump @scalar/api-reference from 1.62.5 to 1.64.0 in /utils (#2780) (e2b085c)
• deps: bump @stoplight/elements from 9.0.21 to 9.0.24 in /utils (#2774) (c8f3e4e)
• deps: bump swagger-ui-dist from 5.32.6 to 5.32.11 in /utils (#2777) (9654f06)

5.10.3 (2026-06-01)

Miscellaneous Chores

• deps: bump @scalar/api-reference from 1.55.3 to 1.57.5 in /utils (#2746) (8ea5151)
• deps: bump @stoplight/elements from 9.0.19 to 9.0.21 in /utils (#2751) (935888a)
• deps: bump redoc from 2.5.2 to 2.5.3 in /utils (#2750) (2c13846)
• deps: bump swagger-ui-dist from 5.32.5 to 5.32.6 in /utils (#2744) (983cfde)

Miscellaneous Chores

• deps: bump @scalar/api-reference from 1.55.3 to 1.57.5 in /utils (#2746) (8ea5151)
• deps: bump @stoplight/elements from 9.0.19 to 9.0.21 in /utils (#2751) (935888a)
• deps: bump redoc from 2.5.2 to 2.5.3 in /utils (#2750) (2c13846)
• deps: bump swagger-ui-dist from 5.32.5 to 5.32.6 in /utils (#2744) (983cfde)

5.10.2 (2026-05-08)

Bug Fixes

• config: root vendor extensions get ignored (#2739) (b80b612)

Bug Fixes

• config: root vendor extensions get ignored (#2739) (b80b612)

5.10.1 (2026-05-08)

Miscellaneous Chores

• deps: bump @scalar/api-reference from 1.52.0 to 1.52.1 in /utils (#2723) (5522bd9)
• deps: bump @scalar/api-reference from 1.52.1 to 1.55.3 in /utils (#2737) (f00777b)
• deps: bump @stoplight/elements from 9.0.16 to 9.0.19 in /utils (#2731) (19142fb)
• deps: bump swagger-ui-dist from 5.32.1 to 5.32.2 in /utils (#2724) (076b2a0)
• deps: bump swagger-ui-dist from 5.32.2 to 5.32.5 in /utils (#2738) (13d09d4)

Miscellaneous Chores

• deps: bump @scalar/api-reference from 1.52.0 to 1.52.1 in /utils (#2723) (5522bd9)
• deps: bump @scalar/api-reference from 1.52.1 to 1.55.3 in /utils (#2737) (f00777b)
• deps: bump @stoplight/elements from 9.0.16 to 9.0.19 in /utils (#2731) (19142fb)
• deps: bump swagger-ui-dist from 5.32.1 to 5.32.2 in /utils (#2724) (076b2a0)
• deps: bump swagger-ui-dist from 5.32.2 to 5.32.5 in /utils (#2738) (13d09d4)

5.10.0 (2026-04-10)

Features

• add support for Scalar UI (#2711) (3c80aa6)

Bug Fixes

• exclude BackedEnum from TranslatablePropertyDescriber (#2692) (2c40b2e), closes #2507
• phpstan: apply phpstan fixes (#2721) (3cbe708)
• prevent nullable from triggering oneOf wrapping in JMSModelDescriber (#2693) (7167809), closes #2565
• use FQCN as deduplication key to prevent model merge across namespaces (#2694) (25e8b98)

Miscellaneous Chores

• deps: bump swagger-ui-dist from 5.32.0 to 5.32.1 in /utils (#2712) (b5d5e1f)
• support zircote/swagger-php ^6.0 (#2717) (3add4a7)
• ui: update scalar & stoplight files (#2719) (94d113b)

Features

• add support for Scalar UI (#2711) (3c80aa6)

Bug Fixes

• exclude BackedEnum from TranslatablePropertyDescriber (#2692) (2c40b2e), closes #2507
• phpstan: apply phpstan fixes (#2721) (3cbe708)
• prevent nullable from triggering oneOf wrapping in JMSModelDescriber (#2693) (7167809), closes #2565
• use FQCN as deduplication key to prevent model merge across namespaces (#2694) (25e8b98)

Miscellaneous Chores

• deps: bump swagger-ui-dist from 5.32.0 to 5.32.1 in /utils (#2712) (b5d5e1f)
• support zircote/swagger-php ^6.0 (#2717) (3add4a7)
• ui: update scalar & stoplight files (#2719) (94d113b)

5.9.5 (2026-03-04)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.15 to 9.0.16 in /utils (#2702) (ff5783b)
• deps: bump swagger-ui-dist from 5.31.0 to 5.32.0 in /utils (#2703) (3d64d5b)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.15 to 9.0.16 in /utils (#2702) (ff5783b)
• deps: bump swagger-ui-dist from 5.31.0 to 5.32.0 in /utils (#2703) (3d64d5b)

5.9.4 (2026-02-20)

Bug Fixes

• #[MapRequestPayload] & #[MapUploadedFile] combined on same route (#2689) (4ff48e7)
• Choice(multiple: true) warning with string[] and type_info (#2690) (1c608db)
• Count constraint uses minProperties/maxProperties for maps (#2688) (e8196ef)
• LegacyType deprecation warning in Configuration (#2687) (3c06392)

Bug Fixes

• #[MapRequestPayload] & #[MapUploadedFile] combined on same route (#2689) (4ff48e7)
• Choice(multiple: true) warning with string[] and type_info (#2690) (1c608db)
• Count constraint uses minProperties/maxProperties for maps (#2688) (e8196ef)
• LegacyType deprecation warning in Configuration (#2687) (3c06392)

5.9.3 (2026-02-04)

Bug Fixes

• composer: conflict for symfony/property-info versions (#2685) (d9f7213)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.13 to 9.0.15 in /utils (#2676) (19c2ab5)
• gitattributes: exclude dev configs (#2683) (65dfa87)

Bug Fixes

• composer: conflict for symfony/property-info versions (#2685) (d9f7213)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.13 to 9.0.15 in /utils (#2676) (19c2ab5)
• gitattributes: exclude dev configs (#2683) (65dfa87)

5.9.2 (2026-01-08)

Bug Fixes

• config: set type_info default correctly in Symfony 8 (#2670) (3e65701)

Bug Fixes

• config: set type_info default correctly in Symfony 8 (#2670) (3e65701)

Bug Fixes

• swagger-ui: dark mode ui background color (#2665) (0303e94)

Miscellaneous Chores

• phpdocumentor: bump support for reflection-docblock & type-resolver (#2666) (75a543d)

Features

• Add support for static callbacks in Symfony choice constraints (#2659) (4d2f627)

Bug Fixes

• OpenApiPhpDescriber: Set annotation name from context, if empty (#2658) (eedb169)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.12 to 9.0.13 in /utils (#2648) (57d40e3)
• deps: bump swagger-ui-dist from 5.30.2 to 5.30.3 in /utils (#2639) (8c804b9)
• deps: bump swagger-ui-dist from 5.30.3 to 5.31.0 in /utils (#2655) (b7fb331)
• symfony: support 8.0 (#2612) (51d6a51)

Bug Fixes

• SplObjectStorage: SplObjectStorage::detach() is deprecated since 8.5, use method SplObjectStorage::offsetUnset() instead (94f6895)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.11 to 9.0.12 in /utils (#2625) (e54c6c2)

Bug Fixes

• configuration: validate type_info option on Symfony 6 (#2615) (3d96b9a)

Features

• #2502: refactor Model::$type from property-info to type-info Type (ef14213)

Bug Fixes

• trigger_deprecation: incorrect & missing trigger_deprecation in Model class (#2613) (52858e6)

Miscellaneous Chores

• php: bump minimum to php 8.2 (#2611) (95b2057)
• symfony: bumped minimum version for Symfony 7 from ^7.1 to ^7.2 (ef14213)

Bug Fixes

• swagger-php 5.7.0 compatatiblity (#2598) (ca4ca49)

Features

• Implement Ulid type description in ClassDescriber (#2556) (5666ba1)

Bug Fixes

• remove unused TypesTrait (#2588) (438894c)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.8 to 9.0.11 in /utils (#2585) (ac85a09)
• deps: bump swagger-ui-dist from 5.29.5 to 5.30.2 in /utils (#2586) (c37c801)

Bug Fixes

• version number in triggered deprecation (#2577) (b5f440c)

Miscellaneous Chores

• deps: bump redoc from 2.5.1 to 2.5.2 in /utils (#2574) (2b49d55)
• deps: bump swagger-ui-dist from 5.29.4 to 5.29.5 in /utils (#2575) (f9fd650)

Bug Fixes

• config: migrate xml to php config (#2566) (2b12914)
• swagger-php: conflict with broken version 5.5.0 (#2568) (a9bbfa7)

Miscellaneous Chores

• deps: bump swagger-ui-dist from 5.29.3 to 5.29.4 in /utils (#2564) (254a487)
• PHPStan v2 (#2572) (3b0abc6)

Miscellaneous Chores

• deps: bump @stoplight/elements from 9.0.6 to 9.0.8 in /utils (#2559) (ab71920)
• deps: bump redoc from 2.5.0 to 2.5.1 in /utils (#2557) (552e1df)
• deps: bump swagger-ui-dist from 5.29.0 to 5.29.3 in /utils (#2560) (9278d86)

Miscellaneous Chores

• deps: bump swagger-ui-dist from 5.28.1 to 5.29.0 in /utils (#2554) (5ad97ac)

Bug Fixes

• ModelRegistry: ensure first registered alternative name is used (#2553) (2f3b3b7)

Miscellaneous Chores

• deps: bump swagger-ui-dist from 5.28.0 to 5.28.1 in /utils (#2548) (dcde65f)

Features

• Model: Allow customizing the name of generated schemas. (#2542) (6a12188)

Miscellaneous Chores

• deps: bump swagger-ui-dist from 5.27.1 to 5.28.0 in /utils (#2538) (0f86e76)

• Schemas deduplication now compare generated schemas to reduce automatically named schemas (Entity / Entity2 / Entity3 / ...).
• Added support for generic types describing

Added support for Symfony's TranslatableInterface

Fixed a bug where using abstract controllers would ignore various attributes like #[OA\Tag] & #[Security] on child classes

Made it possible to automatically generate security definitions based on the #[IsGranted] attribute.

nelmio_api_doc:
    # ...

    areas:
        default:
            security:
                MyBearerScheme:
                    type: 'http'
                    scheme: 'bearer'

Made it possible to configure how operation ids are generated.

nelmio_api_doc:
    operation_id_generation: always_prepend

Possible values: always_prepend, conditionally_prepend, no_prepend or enum instance of Nelmio\ApiDocBundle\Describer\OperationIdGeneration

• Support of attribute MapQueryParameter with a regexp has been improved, it now converts the regexp from PCRE to ECMA-262 for better compliance with OpenApi.

• Added a #[Ignore] attribute that allows a property to be excluded from the generated schema.

<?php

use Nelmio\ApiDocBundle\Attribute\Ignore;

class Foo
{
    #[Ignore]
    private string $ignoredProperty;
}

• Added support for the #[MapUploadedFile] symfony controller argument attribute

• Added Stoplight as an alternative UI option. https://stoplight.io/open-source/elements.

• Passing an array key value with a list of strings to the Areas annotation/attribute is deprecated. Pass the list of strings directly.

-#[Areas(properties: ['value' => ['foo', 'bar']])]
+#[Areas(properties: ['foo', 'bar'])]

-#[Areas(['value' => ['foo', 'bar']])]
+#[Areas(['foo', 'bar'])]

• Configuration option with_annotation has been deprecated in favor of with_attribute

nelmio_api_doc:
    areas:
        path_patterns:
            - ^/api/foo
-       with_annotation: true
+       with_attribute: true

• Added support for the symfony/type-info component

nelmio_api_doc:
  type_info: true

• Changed minimum Symfony version for 7.x from 7.0 to 7.1