docs(jsonld): drop misleading @type TODO, document intentional behavior#8369
Merged
Conversation
The TODO claimed item_uri_template member @type should derive from the object's class instead of the operation. That contradicts the deliberate, tested behavior: members carry the item resource's @type so it matches their @id (which dereferences to the item_uri_template operation, not the collection's own resource). RecipeCollection -> Recipe and CollectionReferencingItem -> ItemReferencedInCollection both rely on this, and PR api-platform#7764 added the branch precisely to restore it. Replace the wrong TODO with a comment explaining the invariant.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
// TODO: 5.x break on this...block inJsonLd\Serializer\ItemNormalizer::resolveType()claimed that, foritem_uri_templatecollections, the member@typeshould be derived from the object's class instead of the operation. The comment hedged itself ("this looks wrong ... ?").After investigation the premise is wrong: members deliberately carry the item resource's
@typeso it matches their@id, which dereferences to theitem_uri_templateoperation rather than to the collection's own resource. Two functional tests rely on exactly this:ItemUriTemplateCollectionTest—RecipeCollection(shortNameCollectionRecipe) members expose@type: Recipe.ItemUriTemplateHydraTest::testCollectionReferencingAnotherResource—CollectionReferencingItemmembers expose@type: ItemReferencedInCollection.Both have object class ≠ item resource, and both assert the item operation's shortName. PR #7764 added this branch precisely to restore that behavior. Switching to the object's class would break
RecipeCollection.No behavioral change: this drops the misleading TODO and replaces the inner comment with one explaining the invariant.