Skip to content

Fix documentation for custom operation configuration #448

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
Mar 23, 2018
Merged

Fix documentation for custom operation configuration #448

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
5 changes: 4 additions & 1 deletion core/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,6 +556,7 @@ use App\Controller\BookSpecial;
* @ApiResource(itemOperations={
* "get",
* "special"={
* "method"="GET",
* "path"="/books/{id}/special",
* "controller"=BookSpecial::class
* }
Expand All @@ -575,6 +576,7 @@ App\Entity\Book:
itemOperations:
get: ~
special:
method: 'GET'
path: '/books/{id}/special'
controller: 'App\Controller\BookSpecial'
```
Expand All @@ -593,6 +595,7 @@ Or in XML:
<itemOperations>
<itemOperation name="get" />
<itemOperation name="special">
<attribute name="method">GET</attribute>
<attribute name="path">/books/{id}/special</attribute>
<attribute name="controller">App\Controller\BookSpecial</attribute>
</itemOperation>
Expand All @@ -601,7 +604,7 @@ Or in XML:
</resources>
```

It is mandatory to set the `path` and `controller` attributes. They allow API platform to configure the routing path and
It is mandatory to set the `method`, `path` and `controller` attributes. They allow API platform to configure the routing path and
the associated controller respectively.

If you want to bypass the automatic retrieval of the entity in your custom operation, you can set the parameter
Expand Down