Skip to content

[Swagger] Doc: Changing the name of a definition #368

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.

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
Dec 27, 2017
Merged
Changes from all commits
Commits
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
49 changes: 48 additions & 1 deletion core/swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ class Product // The class name will be used to name exposed resources
* "swagger_context"={
* "type"="string",
* "enum"={"one", "two"},
* "example"="one"
* "example"="one"
* }
* }
* )
Expand Down Expand Up @@ -179,3 +179,50 @@ Will produce the following Swagger documentation:
}
}
```

## Changing the Name of a Definition

API Platform generates a definition name based on the serializer `groups` defined
in the (`de`)`normalization_context`. It's possible to override the name
thanks to the `swagger_definition_name` option:

```php
/**
* @ApiResource(
* collectionOperations={
* "post"={
* "method"="POST",
* "denormalization_context"={
* "groups"={"user_read"},
* "swagger_definition_name": "Read",
* },
* },
* },
* )
*/
class User
{
}
```

It's also possible to re-use the (`de`)`normalization_context`:

```php
/**
* @ApiResource(
* collectionOperations={
* "post"={
* "method"="POST",
* "denormalization_context"=User::API_WRITE,
* },
* },
* )
*/
class User
{
const API_WRITE = [
'groups' => ['user_read'],
'swagger_definition_name' => 'Read',
];
}
```