Skip to content

show XML syntax for @ApiProperty(identifier=true) #1250

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 3 commits into from
Jan 20, 2021
Merged

show XML syntax for @ApiProperty(identifier=true) #1250

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8d1c634
show XML syntax for @ApiProperty(identifier=true)
yivi Jan 20, 2021
8390e3c
Remove empty lines
alanpoulain Jan 20, 2021
fcbb911
Remove empty lines
alanpoulain Jan 20, 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
10 changes: 10 additions & 0 deletions core/identifiers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ To help with your development experience, we introduced an identifier normalizat

Let's say you have the following class, which is identified by a `UUID` type. In this example, `UUID` is not a simple string but an object with many attributes.

[codeSelector]
```php
<?php
namespace App\Entity;
Expand All @@ -32,6 +33,15 @@ final class Person
}
```

```xml
<resources xmlns="https://api-platform.com/schema/metadata">
<resource class="App\EntityPerson">
<property name="code" identifier="true"/>
</resource>
</resources>
```
[/codeSelector]

Once registered as an `ApiResource`, having an existing person, it will be accessible through the following URL: `/people/110e8400-e29b-11d4-a716-446655440000`.
Note that the property identifying our resource is named `code`.

Expand Down