Skip to content

Commit c4beb99

Browse files
committed
feat(metadata): add some missing docs
1 parent 07b2881 commit c4beb99

File tree

2 files changed

+14
-16
lines changed

2 files changed

+14
-16
lines changed

src/Metadata/ApiProperty.php

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,6 @@ final class ApiProperty
8383
private $securityPostDenormalize;
8484

8585
/**
86-
* The RDF types of this property.
87-
*
8886
* @var string[]
8987
*/
9088
private $types;
@@ -108,21 +106,21 @@ final class ApiProperty
108106
* @param string $description
109107
* @param bool $readable
110108
* @param bool $writable
111-
* @param bool $readableLink
112-
* @param bool $writableLink
113-
* @param bool $required
114-
* @param bool $identifier
109+
* @param bool $readableLink https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
110+
* @param bool $writableLink https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
111+
* @param bool $required https://api-platform.com/docs/admin/validation/#client-side-validation
112+
* @param bool $identifier https://api-platform.com/docs/core/identifiers/
115113
* @param string|int|float|bool|array $default
116-
* @param string|int|float|bool|array $example
117-
* @param string $deprecationReason
114+
* @param string|int|float|bool|array $example https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
115+
* @param string $deprecationReason https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
118116
* @param bool $fetchable
119-
* @param bool $fetchEager
120-
* @param array $jsonldContext
121-
* @param array $openapiContext
122-
* @param bool $push
123-
* @param string $security
124-
* @param string $securityPostDenormalize
125-
* @param string[]|string $types
117+
* @param bool $fetchEager https://api-platform.com/docs/core/performance/#eager-loading
118+
* @param array $jsonldContext https://api-platform.com/docs/core/extending-jsonld-context/#extending-json-ld-and-hydra-contexts
119+
* @param array $openapiContext https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
120+
* @param bool $push https://api-platform.com/docs/core/push-relations/
121+
* @param string $security https://api-platform.com/docs/core/security
122+
* @param string $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
123+
* @param string[]|string $types the RDF types of this property
126124
*/
127125
public function __construct(
128126
?string $description = null,

src/Metadata/ApiResource.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ final class ApiResource
113113
* @param string $uriTemplate
114114
* @param string $shortName
115115
* @param string $description
116-
* @param string[]|string $types
116+
* @param string[]|string $types The RDF types of this resource
117117
* @param array|string $formats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
118118
* @param array|string $inputFormats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
119119
* @param array|string $outputFormats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation

0 commit comments

Comments
 (0)