References ApiProperty
Reference
A
Attribute

ApiPlatform\Metadata\ApiProperty

OptionTypesDescription
`description`string
`readable`bool
`writable`bool
`readableLink`boolhttps://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
`writableLink`boolhttps://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
`required`boolhttps://api-platform.com/docs/admin/validation/#client-side-validation
`identifier`boolhttps://api-platform.com/docs/core/identifiers/
`default`string
`example`https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
`deprecationReason`stringhttps://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
`fetchable`bool
`fetchEager`boolhttps://api-platform.com/docs/core/performance/#eager-loading
`jsonldContext`arrayhttps://api-platform.com/docs/core/extending-jsonld-context/#extending-json-ld-and-hydra-contexts
`openapiContext`arrayhttps://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
`jsonSchemaContext`array
`push`boolhttps://api-platform.com/docs/core/push-relations/
`security`string
Stringable
https://api-platform.com/docs/core/security
`securityPostDenormalize`string
Stringable
https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
`types`array<int, string>the RDF types of this property
`builtinTypes`array<int, Symfony\Component\PropertyInfo\Type>
`schema`array
`initializable`bool
`iris`array<int, string>
`genId`bool
`uriTemplate`string(experimental) whether to return the subRessource collection IRI instead of an iterable of IRI
`extraProperties`array

Description

ApiProperty annotation.

Options

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop