Skip to content

docs(external-vocabularies): compatibility with laravel #2087

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 1 commit into from
Dec 9, 2024
Merged

docs(external-vocabularies): compatibility with laravel #2087

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
57 changes: 36 additions & 21 deletions core/external-vocabularies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ API Platform provides attributes usable on PHP classes and properties for specif

```php
<?php
// api/src/Entity/Book.php
namespace App\Entity;
// api/src/ApiResource/Book.php with Symfony or app/ApiResource/Book.php with Laravel
namespace App\ApiResource;

use ApiPlatform\Metadata\ApiProperty;
use ApiPlatform\Metadata\ApiResource;
Expand Down Expand Up @@ -52,22 +52,37 @@ The generated JSON for products and the related context document will now use ex

An extended list of existing open vocabularies is available on [the Linked Open Vocabularies (LOV) database](https://lov.linkeddata.es/dataset/lov/).

By default, when using [validations](validation.md) API Platform will try to define known [Schema.org](https://schema.org) types as IRIs for your properties if you did not provide any in your `#[ApiProperty]` attributes.
Built-in mapping is:

| Constraints | Schema.org type |
| ---------------------------------------------------- | ---------------------------------- |
| `Symfony\Component\Validator\Constraints\Url` | `https://schema.org/url` |
| `Symfony\Component\Validator\Constraints\Email` | `https://schema.org/email` |
| `Symfony\Component\Validator\Constraints\Uuid` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\CardScheme` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\Bic` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\Iban` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\Date` | `https://schema.org/Date` |
| `Symfony\Component\Validator\Constraints\DateTime` | `https://schema.org/DateTime` |
| `Symfony\Component\Validator\Constraints\Time` | `https://schema.org/Time` |
| `Symfony\Component\Validator\Constraints\Image` | `https://schema.org/image` |
| `Symfony\Component\Validator\Constraints\File` | `https://schema.org/MediaObject` |
| `Symfony\Component\Validator\Constraints\Currency` | `https://schema.org/priceCurrency` |
| `Symfony\Component\Validator\Constraints\Isbn` | `https://schema.org/isbn` |
| `Symfony\Component\Validator\Constraints\Issn` | `https://schema.org/issn` |
By default, when using [validations](validation.md) API Platform will try to define known [Schema.org](https://schema.org)
types as IRIs for your properties if you did not provide any in your `#[ApiProperty]` attributes.

- Symfony built-in mapping is:

| Constraints | Schema.org type |
|------------------------------------------------------|------------------------------------|
| `Symfony\Component\Validator\Constraints\Url` | `https://schema.org/url` |
| `Symfony\Component\Validator\Constraints\Email` | `https://schema.org/email` |
| `Symfony\Component\Validator\Constraints\Uuid` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\CardScheme` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\Bic` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\Iban` | `https://schema.org/identifier` |
| `Symfony\Component\Validator\Constraints\Date` | `https://schema.org/Date` |
| `Symfony\Component\Validator\Constraints\DateTime` | `https://schema.org/DateTime` |
| `Symfony\Component\Validator\Constraints\Time` | `https://schema.org/Time` |
| `Symfony\Component\Validator\Constraints\Image` | `https://schema.org/image` |
| `Symfony\Component\Validator\Constraints\File` | `https://schema.org/MediaObject` |
| `Symfony\Component\Validator\Constraints\Currency` | `https://schema.org/priceCurrency` |
| `Symfony\Component\Validator\Constraints\Isbn` | `https://schema.org/isbn` |
| `Symfony\Component\Validator\Constraints\Issn` | `https://schema.org/issn` |

- Laravel built-in mapping is:

| Laravel Validation Rule | Schema.org Type |
|-------------------------------|------------------------------------|
| `url` | `https://schema.org/url` |
| `email` | `https://schema.org/email` |
| `uuid` | `https://schema.org/identifier` |
| `date` | `https://schema.org/Date` |
| `date_format:Y-m-d H:i:s` | `https://schema.org/DateTime` |
| `date_format:H:i` | `https://schema.org/Time` |
| `image` | `https://schema.org/image` |
| `mimes` or `mimetypes` | `https://schema.org/MediaObject` |
Loading