feat: BackedEnum resources #6309
Conversation
GwendolenLynch
force-pushed
the
feat/enum-resources
branch
7 times, most recently
from
8c96867
to
8acce05
Compare
| @@ -59,6 +59,9 @@ public function createLinksFromIdentifiers(Metadata $operation): array | |||
|
|
|||
| $link = (new Link())->withFromClass($resourceClass)->withIdentifiers($identifiers); | |||
| $parameterName = $identifiers[0]; | |||
| if ('value' === $parameterName && enum_exists($resourceClass)) { | |||
| $parameterName = 'id'; | |||
| } | |||
There was a problem hiding this comment.
Does this match what you had in mind @soyuka?
There was a problem hiding this comment.
Uri variable should be as followed:
uriVariables: ['id' => new Link(parameterName: 'id', identifiers: ['value'])]
in the metadata directly so that we don't need any condition here right?
There was a problem hiding this comment.
Apologies, but I'm confused again 😇 … I'm probably missing something obvious, but the Link is constructed directly above, and the parameterName is set at return: $link->withParameterName($parameterName) … So is your suggestion how that return array should be shaped? If so what about non-enums?
There was a problem hiding this comment.
Which raises another thing about the createLinksFromIdentifiers method … If the $identifier array is empty there is an early return (lines 56-58), and then there is the if (1 < \count($identifiers)) { (lines 66-69) test that looks like dead code, correct?
Scrap this one, I was reading the comparison backwards in my head … confusion reigns today 😟
There was a problem hiding this comment.
I need to check this into the details, will try to find some time!
|
I would use URIs in GraphQL too, as we do for existing IDs and relations. WDYT? |
|
@dunglas it must be my week for getting confused. 🌞 I'm very happy to make required changes, but could you be so kind as to give a bit more context, please? |
|
Please look at how I configure a backed enum as an API resource so that each instance has an IRI just like any other API resource. https://github.com/gnito-org/problem-replicator-api-platform-enum-example This is important for machine discovery of APIs and for consistency. |
|
Thank you @gnito-org, I can reproduce it here. |
GwendolenLynch
force-pushed
the
feat/enum-resources
branch
2 times, most recently
from
e99f735
to
3df9f0b
Compare
GwendolenLynch
force-pushed
the
feat/enum-resources
branch
3 times, most recently
from
37672db
to
b088d10
Compare
GwendolenLynch
force-pushed
the
feat/enum-resources
branch
3 times, most recently
from
e227f3c
to
a069f68
Compare
Intended for 3.4, so now it is just for review.
Depends on #6288 as I want to refactor
BackedEnumPlainResourceTesttest methods into those classes.BackedEnumsvalueby default, and implementingfunction getId(), etc, works tooGet&GetCollectionunless otherwise configuredGET /statuses[ { "name": "DRAFT", "value": 0 }, { "name": "PUBLISHED", "value": 1 } ]GET /statuses/1{ "name": "PUBLISHED", "value": 1 }