Custom Get URI Template always enforces ID

[Dasc3er]

API Platform version(s) affected: x.y.z

Description

When setting up a simple Get endpoint with a different path param from ID (ID not available), the system assumes the first path param is ID on the UI if the resource has a ID field.

The issue does not happen if there is not a ID field.

It is unclear if the issue is on the OpenAPI UI proxy here or something else more in depth.

How to reproduce

#[ApiResource(
    shortName: 'Test',
    operations: [
        new Get(
            uriTemplate: '/test/{dir}',
        ),new Get(
            uriTemplate: '/test/{id}/{dir}',
        ),
    ]
)]
class TestResource
{
    public int $id;
}

#[ApiResource(
    shortName: 'Test2',
    operations: [
        new Get(
            uriTemplate: '/test2/{dir}',
        ),new Get(
            uriTemplate: '/test2/{id}/{dir}',
        ),
    ]
)]
class Test2Resource
{
    public int $not_id;
}

[soyuka]

This is expected behavior, and the fix is to declare uriVariables explicitly.

When you set a uriTemplate but omit uriVariables, API Platform auto-builds the URI variables from the template's path variables (UriTemplateResourceMetadataCollectionFactory). For each variable it can't match to a property on the resource, it falls back to the id identifier:

$newUriVariables[$variable] = (new Link())
    ->withFromClass($operation->getClass())
    ->withIdentifiers([property_exists($operation->getClass(), $variable) ? $variable : 'id'])
    ->withParameterName($variable);

Your {dir} isn't a property on TestResource, so it's mapped to the id identifier — that's the "enforced ID" you see in the UI.

Declare the variable so it maps to what you actually want, and the auto-defaulting is skipped entirely (variable count matches, so it's left as-is):

use ApiPlatform\Metadata\Link;

#[ApiResource(
    shortName: 'Test',
    operations: [
        new Get(
            uriTemplate: '/test/{dir}',
            uriVariables: [
                'dir' => new Link(fromClass: TestResource::class, identifiers: ['dir']),
            ],
        ),
        new Get(uriTemplate: '/test/{id}/{dir}'),
    ],
)]

If dir isn't an identifier at all (just a routing param), model it with a Parameter instead of a uriVariable.