Skip to content

Conversation

@VincentLanglet
Copy link
Contributor

Q A
Branch? main for features / current stable version branch for bug fixes
Tickets Closes #..., closes #...
License MIT
Doc PR api-platform/docs#...

Hi @soyuka I'm getting multiple issues with the auto generated documentation for Filters.
One of them is the fact we cannot override the description manually with the following syntax

'brandWithDescription' => new QueryParameter(
      filter: new ExactFilter(),
      description: 'Extra description about the filter',
),

Without this fix you're getting '' as description...

#7634 helped to find the fix and the test to write.

@soyuka
Copy link
Member

soyuka commented Jan 8, 2026

Thanks @VincentLanglet I took the liberty of changing the approach by modifying the OpenApiFactory instead of the filters! Waiting for CI before merging.

@VincentLanglet
Copy link
Contributor Author

Thanks @VincentLanglet I took the liberty of changing the approach by modifying the OpenApiFactory instead of the filters! Waiting for CI before merging.

Thanks.

Seems like the failure is failing now then. I let you choose if it's an expected (new) behavior then :)

@soyuka soyuka force-pushed the fix/keep-description-in-filter branch from 48974a4 to e799de2 Compare January 8, 2026 15:21
@soyuka soyuka merged commit 39c5583 into api-platform:4.2 Jan 8, 2026
130 checks passed
@soyuka
Copy link
Member

soyuka commented Jan 8, 2026

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants