feat: defaults parameters by Maxcastel · Pull Request #7758 · api-platform/core

Maxcastel · 2026-02-13T13:40:35Z

Q	A
Branch?	main
Tickets	Closes #7509
License	MIT
Doc PR	api-platform/docs#...

Description

This PR allows to define global default parameters that are applied to all resources instead of configuring the parameter individually on each resource.

Before

#[ApiResource(
    operations: [
        new GetCollection(
            parameters: [
                new HeaderParameter(
                    key: 'X-API-Token',
                    required: true,
                    description: 'API Token',
                ),
            ],
        ),
    ],
)]
class Book
{

}

#[ApiResource(
    operations: [
        new GetCollection(
            parameters: [
                new HeaderParameter(
                    key: 'X-API-Token',
                    required: true,
                    description: 'API Token',
                ),
            ],
        ),
    ],
)]
class Author
{

}

After

api_platform:
    defaults:
        parameters:
            ApiPlatform\Metadata\HeaderParameter:
                key: 'X-API-Token'
                required: true
                description: 'API Token'

#[ApiResource]
class Book
{

}

#[ApiResource]
class Author
{

}

Other exemple with two Parameter

api_platform:
    title: My API
    version: 1.0.0
    defaults:
        parameters:
            ApiPlatform\Metadata\HeaderParameter:
                key: 'X-API-Token'
                required: true
                description: 'API authentication token'
            
            ApiPlatform\Metadata\QueryParameter:
                key: 'api_version'
                required: false
                description: 'API version'

soyuka · 2026-02-18T08:07:36Z

src/Symfony/Bundle/DependencyInjection/Configuration.php

+                            ->booleanNode('hydra')->defaultNull()->info('Include this parameter in Hydra documentation.')->end()
+                            ->variableNode('constraints')->defaultNull()->info('Validation constraints.')->end()
+                            ->scalarNode('security')->defaultNull()->info('The security expression.')->end()
+                            ->scalarNode('security_message')->defaultNull()->info('The security message.')->end()


Couldn't you use the defineDefault method of this class? It makes this automatic.

done in 1da905e

soyuka

Could you use the automatic method for configuration? the rest is awesome!

Maxcastel · 2026-02-18T13:09:30Z

Also changed the priority of DefaultParametersResourceMetadataCollectionFactory (150 to 1001) so that it is higher than ParameterValidationResourceMetadataCollectionFactory (1000) and therefore executed before it, otherwise, it doesn’t work (tested on a real project by changing the version of "api-platform/core" to "dev-feature/config-defaults-parameters", and it works).

Currently, when changing the priority of DefaultParametersResourceMetadataCollectionFactory, all tests still pass. Should we add a functional test that fails if the priority is set to 150 (or any value lower than 1001)? How could we test this behavior?

soyuka · 2026-02-18T14:26:34Z

It's a hard problem + there's no bc-layer on priorities... I suggest to merge the code of your default factory to the one handling parameters. I know it'll be more code in a class but it keeps a better responsibility over this in my opinion.

soyuka · 2026-02-18T15:24:41Z

...Validator/Metadata/Resource/Factory/ParameterValidationResourceMetadataCollectionFactory.php

+        return new $parameterClass(
+            key: $config['key'] ?? null,
+            schema: $config['schema'] ?? null,
+            openApi: null,
+            provider: null,
+            filter: $config['filter'] ?? null,
+            property: $config['property'] ?? null,
+            description: $config['description'] ?? null,
+            properties: null,
+            required: $config['required'] ?? false,
+            priority: $config['priority'] ?? null,
+            hydra: $config['hydra'] ?? null,
+            constraints: $config['constraints'] ?? null,
+            security: $config['security'] ?? null,
+            securityMessage: $config['security_message'] ?? null,
+            extraProperties: $config['extra_properties'] ?? [],
+            filterContext: null,
+            nativeType: null,
+            castToArray: null,
+            castToNativeType: null,
+            castFn: null,
+            default: $config['default'] ?? null,
+            filterClass: $config['filter_class'] ?? null,
+        );


create a an array and name convert all the keys so that you can call __construct with arguments (programatically) we know they match as the configuration does it the other way around

done in 87829ee

…to ParameterValidationResourceMetadataCollectionFactory

Maxcastel changed the title ~~test defaults parameters~~ feat: defaults parameters Feb 13, 2026

Maxcastel force-pushed the feature/config-defaults-parameters branch 2 times, most recently from 98b777f to e4ad0c9 Compare February 16, 2026 15:39

Maxcastel marked this pull request as ready for review February 16, 2026 15:48

soyuka reviewed Feb 18, 2026

View reviewed changes

Maxcastel force-pushed the feature/config-defaults-parameters branch from e4ad0c9 to f41ef4c Compare February 18, 2026 12:15

feat: defaults parameters

88619ac

Maxcastel force-pushed the feature/config-defaults-parameters branch from 1da905e to 88619ac Compare February 18, 2026 13:02

Maxcastel force-pushed the feature/config-defaults-parameters branch from bfab314 to 2d31329 Compare February 18, 2026 15:24

soyuka reviewed Feb 18, 2026

View reviewed changes

Maxcastel force-pushed the feature/config-defaults-parameters branch from 2d31329 to 87829ee Compare February 18, 2026 15:48

Maxcastel added 2 commits February 18, 2026 17:05

refactor: merge DefaultParametersResourceMetadataCollectionFactory in…

1b6985c

…to ParameterValidationResourceMetadataCollectionFactory

refactor: create array and name convert all keys

12fb7fb

Maxcastel force-pushed the feature/config-defaults-parameters branch 2 times, most recently from 3e4abbb to 12fb7fb Compare February 18, 2026 16:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: defaults parameters#7758

feat: defaults parameters#7758
Maxcastel wants to merge 3 commits intoapi-platform:mainfrom
Maxcastel:feature/config-defaults-parameters

Maxcastel commented Feb 13, 2026 •

edited

Loading

Uh oh!

soyuka Feb 18, 2026

Uh oh!

Maxcastel Feb 18, 2026

Uh oh!

soyuka left a comment

Uh oh!

Maxcastel commented Feb 18, 2026 •

edited

Loading

Uh oh!

soyuka commented Feb 18, 2026

Uh oh!

soyuka Feb 18, 2026

Uh oh!

Maxcastel Feb 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Uh oh!

Conversation

Maxcastel commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Before

After

Other exemple with two Parameter

Uh oh!

soyuka Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Maxcastel Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

soyuka left a comment

Choose a reason for hiding this comment

Uh oh!

Maxcastel commented Feb 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

soyuka commented Feb 18, 2026

Uh oh!

soyuka Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Maxcastel Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Maxcastel commented Feb 13, 2026 •

edited

Loading

Maxcastel commented Feb 18, 2026 •

edited

Loading