Conversation
The example on this page used `ApiProperty(types:)` on a property and then showed a JSON-LD `@context` that only `iris` produces. Property `types` reaches no RDF output at all: its only consumer is the `externalDocs.url` field of the generated OpenAPI schema. Fixes the example and adds a section stating which attribute drives which output. Closes api-platform/core#7051
This branch has not been deployed
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 example on this page declared
#[ApiProperty(types: ['https://schema.org/name'])]and then showed a JSON-LD@contextmappingnameto that IRI. That output only ever comes fromiris.Verified on
api-platform/corebranch4.4:irison a property is read atsrc/JsonLd/ContextBuilder.php:200for the@contextand atsrc/Hydra/Serializer/DocumentationNormalizer.php:582for the Hydra documentation. Without it, both fall back to a local term built from the short name.typeson a property has exactly one consumer,externalDocs.urlinsrc/JsonSchema/Metadata/Property/Factory/SchemaPropertyMetadataFactory.php:120. It reaches no RDF output.typeson a resource does work as documented:src/JsonLd/Serializer/ItemNormalizer.php:159for the@type,src/Hydra/Serializer/DocumentationNormalizer.php:155forsubClassOf.This fixes the example and adds a short section naming which attribute drives which output.
Closes api-platform/core#7051