Skip to content

Fix some doc typos and a broken ink #626

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 1 commit into from
Oct 19, 2018
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion core/dto.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ There is two solutions to achieve that:

#### Use Swagger Decorator

By following the doc about [Override the Swagger Documentation](swagger.md##overriding-the-swagger-documentation)
By following the doc about [Override the Swagger Documentation](swagger.md#overriding-the-swagger-documentation)
and adding the ability to retrieve a `_api_swagger_context` in route
parameters, you should be able to display your custom endpoint.

Expand Down
2 changes: 1 addition & 1 deletion core/file-upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ vich_uploader:

## Configuring the Entity Receiving the Uploaded File

In our exemple, we will create a `MediaObject` API resource. We will post files
In our example, we will create a `MediaObject` API resource. We will post files
to this resource endpoint, and then link the newly created resource to another
resource (in our case: Book).

Expand Down
4 changes: 2 additions & 2 deletions core/serialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ class Book
}
```

The following rules apply when denormalizating embedded relations:
The following rules apply when denormalizing embedded relations:

* If an `@id` key is present in the embedded resource, then the object corresponding to the given URI will be retrieved through
the data provider. Any changes in the embedded relation will also be applied to that object.
Expand Down Expand Up @@ -607,7 +607,7 @@ final class ApiNormalizer implements NormalizerInterface, DenormalizerInterface,
API Platform is able to guess the entity identifier using [Doctrine metadata](http://doctrine-orm.readthedocs.org/en/latest/reference/basic-mapping.html#identifiers-primary-keys).
It also supports composite identifiers.

If you are not using the Doctrine ORM Provider, you must explictely mark the identifier using the `identifier` attribute of
If you are not using the Doctrine ORM Provider, you must explicitly mark the identifier using the `identifier` attribute of
the `ApiPlatform\Core\Annotation\ApiProperty` annotation. For example:


Expand Down
2 changes: 1 addition & 1 deletion core/swagger.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ class Product // The class name will be used to name exposed resources
public $id;

/**
* @param string $name A name property - this description will be avaliable in the API documentation too.
* @param string $name A name property - this description will be available in the API documentation too.
*
* @ORM\Column
* @Assert\NotBlank
Expand Down