Reference
A
Attribute

ApiPlatform\Metadata\ApiProperty

OptionTypesDescription
descriptionstring
readablebool
writablebool
readableLinkboolhttps://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
writableLinkboolhttps://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
requiredboolhttps://api-platform.com/docs/admin/validation/#client-side-validation
identifierboolhttps://api-platform.com/docs/core/identifiers/
defaultstring
examplehttps://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
deprecationReasonstringhttps://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
fetchablebool
fetchEagerboolhttps://api-platform.com/docs/core/performance/#eager-loading
jsonldContextarrayhttps://api-platform.com/docs/core/extending-jsonld-context/#extending-json-ld-and-hydra-contexts
openapiContextarrayhttps://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
jsonSchemaContextarray
pushboolhttps://api-platform.com/docs/core/push-relations/
securitystringhttps://api-platform.com/docs/core/security
securityPostDenormalizestringhttps://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
typesarray<int, string>the RDF types of this property
builtinTypesarray<int, Symfony\Component\PropertyInfo\Type>
schemaarray
initializablebool
irisarray<int, string>
genIdbool
extraPropertiesarray

Description

ApiProperty annotation.

Options

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop