Skip to content

feat(medata): ApiProperty: fix types and improve docs #4427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 7, 2021
Merged

feat(medata): ApiProperty: fix types and improve docs #4427

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07b2881
fix(metadata): allow to pass a string as RDF type for properties
dunglas Sep 7, 2021
c4beb99
feat(metadata): add some missing docs
dunglas Sep 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions src/Metadata/ApiProperty.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,6 @@ final class ApiProperty
private $securityPostDenormalize;

/**
* The related schemas.
*
* @var string[]
*/
private $types;
Expand All @@ -108,20 +106,21 @@ final class ApiProperty
* @param string $description
* @param bool $readable
* @param bool $writable
* @param bool $readableLink
* @param bool $writableLink
* @param bool $required
* @param bool $identifier
* @param bool $readableLink https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
* @param bool $writableLink https://api-platform.com/docs/core/serialization/#force-iri-with-relations-of-the-same-type-parentchilds-relations
* @param bool $required https://api-platform.com/docs/admin/validation/#client-side-validation
* @param bool $identifier https://api-platform.com/docs/core/identifiers/
* @param string|int|float|bool|array $default
* @param string|int|float|bool|array $example
* @param string $deprecationReason
* @param string|int|float|bool|array $example https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
* @param string $deprecationReason https://api-platform.com/docs/core/deprecations/#deprecating-resource-classes-operations-and-properties
* @param bool $fetchable
* @param bool $fetchEager
* @param array $jsonldContext
* @param array $openapiContext
* @param bool $push
* @param string $security
* @param string $securityPostDenormalize
* @param bool $fetchEager https://api-platform.com/docs/core/performance/#eager-loading
* @param array $jsonldContext https://api-platform.com/docs/core/extending-jsonld-context/#extending-json-ld-and-hydra-contexts
* @param array $openapiContext https://api-platform.com/docs/core/openapi/#using-the-openapi-and-swagger-contexts
* @param bool $push https://api-platform.com/docs/core/push-relations/
* @param string $security https://api-platform.com/docs/core/security
* @param string $securityPostDenormalize https://api-platform.com/docs/core/security/#executing-access-control-rules-after-denormalization
* @param string[]|string $types the RDF types of this property
*/
public function __construct(
?string $description = null,
Expand All @@ -132,8 +131,8 @@ public function __construct(
?bool $required = null,
?bool $identifier = null,

$default = null,
$example = null,
$default = null,
$example = null,

?string $deprecationReason = null,
?bool $fetchable = null,
Expand All @@ -144,7 +143,7 @@ public function __construct(
?string $security = null,
?string $securityPostDenormalize = null,

?array $types = [],
$types = [],
?array $builtinTypes = [],
?array $schema = [],
?bool $initializable = null,
Expand All @@ -170,7 +169,7 @@ public function __construct(
$this->security = $security;
$this->openapiContext = $openapiContext;
$this->securityPostDenormalize = $securityPostDenormalize;
$this->types = $types;
$this->types = (array) $types;
$this->builtinTypes = $builtinTypes;
$this->schema = $schema;
$this->initializable = $initializable;
Expand Down Expand Up @@ -403,10 +402,13 @@ public function getTypes(): ?array
return $this->types;
}

public function withTypes(array $types = []): self
/**
* @param string[]|string $types
*/
public function withTypes($types = []): self
{
$self = clone $this;
$self->types = $types;
$self->types = (array) $types;

return $self;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Metadata/ApiResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ final class ApiResource
* @param string $uriTemplate
* @param string $shortName
* @param string $description
* @param string[]|string $types
* @param string[]|string $types The RDF types of this resource
* @param array|string $formats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
* @param array|string $inputFormats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
* @param array|string $outputFormats https://api-platform.com/docs/core/content-negotiation/#configuring-formats-for-a-specific-resource-or-operation
Expand Down