Proposal: Ability to specify identifier property of custom item operations

[soyuka]

Q	A
Bug fix?	not really
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	(need to add tests)
Fixed tickets	#2116
License	MIT
Doc PR	todo

When declaring a custom item operation, you often want to use another property as identifier, for example:

<?php
/**
 * @ApiResource(itemOperations={
 *     "get",
 *     "put",
 *     "get_by_isbn"={"method"="GET", "path"="/books/by_isbn/{isbn}.{_format}", "requirements"={"isbn"=".+"}}
 * })
 */
class Book {}

Today, this only works if you add a custom controller, either by using your own data or by calling the core data provider with new identifiers ['isbn' => 1].

My proposal is to add a property in the operation route defaults:

<?php
/*
 * @ApiResource(itemOperations={
 *     "get",
 *     "put",
 *     "get_by_isbn"={"method"="GET", "path"="/books/by_isbn/{isbn}.{_format}", "requirements"={"isbn"=".+"}, "defaults"={"identifiedBy"="isbn"}}
 * })
 */
class Book {}

By using this you have nothing else to add (no controller, no data provider), it'll just use the isbn property as identifier.

This is a WIP, to be done:

• accept proposal
• add tests

[ziiko10]

Hello
I want to use custom identifier in a custom action without using {id} like this .

 @ApiResource(
   itemOperations={
     "FORGOT-PASSWORD"={
      "method"="PUT",
      "path"="/users/{forgotPasswordToken}/forgot-password",
      "controller"="App\Controller\ForgotPasswordController",
      "defaults"={"identifiedBy"="forgotPasswordToken"}
      }
    }
  )

But i still have the same error with "Invalid identifier value or configuration" .

Any issue please ?

[teohhanhui]

This should probably not be in the route defaults.

[teohhanhui]

@AbbesBendaoud10 It's not implemented yet.

[soyuka]

This should probably not be in the route defaults.

👍 should be a new attribute

[hafkenscheid]

Any news regarding this?

[lamb0tiana]

@soyuka @AbbesBendaoud10 how did you resolved that, I spent 2 days but nothing, would you help please, thank you.

[ziiko10]

@lamb0tiana i did it with "_api_receive"=false.

[soyuka]

Use a custom route with a custom controller / data provider.

[souhaiboutoure]

@lamb0tiana i did it with "_api_receive"=false.

@AbbesBendaoud10 Thanks it worked for me 🥇

[soyuka]

#3664