Add itemUriTemplate to resources.xsd #5872
Conversation
Wojdylak
commented
Oct 6, 2023
Wojdylak
commented
| Q | A |
|---|---|
| Branch? | 3.1 |
| Tickets | N/A |
| License | MIT |
Wojdylak
force-pushed
the
miss-item-uri-template
branch
from
ca926af to
f194c5a
Compare
| <xsd:attribute type="xsd:boolean" name="openapi"/> | ||
| <xsd:attribute type="xsd:positiveInteger" name="priority"/> | ||
| <xsd:attribute type="xsd:string" name="name"/> | ||
| <xsd:attribute type="xsd:string" name="itemUriTemplate"/> |
There was a problem hiding this comment.
as this is not declared on every operation I'm not sure
There was a problem hiding this comment.
But I got an error when I used itemUriTemplete. Element '{https://api-platform.com/schema/metadata/resources-3.0}operation', attribute 'itemUriTemplate': The attribute 'itemUriTemplate' is not allowed.
There was a problem hiding this comment.
itemUriTemplate is only available on GetCollection and Post operations. But I'm not sure it's possible to handle such difference with XML schema...
A solution would be to allow this attribute on XML and YAML schemas, and add a specific validation on XmlResourceExtractor and YamlResourceExtractor services to ensure this attribute is only set on a GetCollection or Post operation, otherwise throw an error. The XmlExtractorTest and YamlExtractorTest should help to test this behavior.
There was a problem hiding this comment.
Note: apparently, I already did a similar check in resource extractors 😃
https://github.com/api-platform/core/blob/3.1/src/Metadata/Extractor/XmlResourceExtractor.php#L387-L389
https://github.com/api-platform/core/blob/3.1/src/Metadata/Extractor/YamlResourceExtractor.php#L323-L325
Throwing an exception if the operation does not match could improve the DX instead of just ignoring the key (PR in progress).
|
let's merge that for now, I'd like @vincentchalamon insights on this |
3 participants
