Skip to content

Commit 023f542

Browse files
author
Thibaudeau Pierre
committed
markdown linter
1 parent c3fec81 commit 023f542

File tree

8 files changed

+12
-2
lines changed

8 files changed

+12
-2
lines changed

core/data-persisters.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ persist data for a given resource will be used.
2323
## Creating a Custom Data Persister
2424

2525
If the [Symfony MakerBundle](https://symfony.com/doc/current/bundles/SymfonyMakerBundle) is installed in your project, you can use the following command to generate a custom data persister easily:
26+
2627
```console
2728
bin/console make:data-persister
2829
```
@@ -190,6 +191,7 @@ final class BlogPostDataPersister implements ContextAwareDataPersisterInterface,
190191
```
191192

192193
This is very useful when using [`Messenger` with API Platform](messenger.md) as you may want to do something asynchronously with the data but still call the default Doctrine data persister, for example:
194+
193195
```php
194196
namespace App\DataPersister;
195197

@@ -230,6 +232,7 @@ final class BlogPostDataPersister implements ContextAwareDataPersisterInterface,
230232
}
231233
}
232234
```
235+
233236
```yaml
234237
# api/config/services.yaml
235238
services:

core/data-providers.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Note, that if your entity is not Doctrine-related, you need to flag the identifi
2828
## Custom Collection Data Provider
2929

3030
If the [Symfony MakerBundle](https://symfony.com/doc/current/bundles/SymfonyMakerBundle) is installed in your project, you can use the following command to generate a custom collection data provider easily:
31+
3132
```console
3233
bin/console make:data-provider --collection-only
3334
```
@@ -85,6 +86,7 @@ You can find a full working example in the [API Platform's demo application](htt
8586
## Custom Item Data Provider
8687

8788
If the [Symfony MakerBundle](https://symfony.com/doc/current/bundles/SymfonyMakerBundle) is installed in your project, you can use the following command to generate a custom item data provider easily:
89+
8890
```console
8991
bin/console make:data-provider --item-only
9092
```

core/file-upload.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,7 @@ your data, you will get a response looking like this:
228228
### Accessing Your Media Objects Directly
229229

230230
You will need to modify your Caddyfile to allow the above `contentUrl` to be accessed directly. If you followed the above configuration for the VichUploaderBundle, that will be in `api/public/media`. Add your folder to the list of path matches, e.g. `|^/media/|`:
231+
231232
```caddyfile
232233
...
233234
# Matches requests for HTML documents, for static files and for Next.js files,

core/filters.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ The `after` and `before` filters will filter including the value whereas `strict
253253
Like others filters, the date filter must be explicitly enabled:
254254

255255
[codeSelector]
256+
256257
```php
257258
<?php
258259
// api/src/Entity/Offer.php

core/graphql.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1902,11 +1902,12 @@ class MediaObject
19021902
}
19031903
}
19041904
```
1905+
19051906
'file' => ['type' => 'Upload!','description' => 'The file to upload']
19061907
'files' => ['type' => '[Upload!]!','description' => 'Files to upload']
19071908

19081909
As you can see, a dedicated type `Upload` is used in the argument of the `upload` mutation.
1909-
If you need to upload multiple files, replace
1910+
If you need to upload multiple files, replace
19101911
`'file' => ['type' => 'Upload!','description' => 'The file to upload']`
19111912
with `'files' => ['type' => '[Upload!]!','description' => 'Files to upload']`.
19121913

core/operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Note: the `PATCH` method must be enabled explicitly in the configuration, refer
4444

4545
Note: with JSON Merge Patch, the [null values will be skipped](https://symfony.com/doc/current/components/serializer.html#skipping-null-values) in the response.
4646

47-
Note: Current `PUT` implementation behaves more or less like the `PATCH` method. Existing properties not included in the payload are **not** removed, their current values are preserved. To remove an existing property, its value must be explicitly set to `null`. Implementing [the standard `PUT` behavior](https://httpwg.org/specs/rfc7231.html#PUT) is on the roadmap, follow [issue #4344] (https://github.com/api-platform/core/issues/4344) to track the progress.
47+
Note: Current `PUT` implementation behaves more or less like the `PATCH` method. Existing properties not included in the payload are **not** removed, their current values are preserved. To remove an existing property, its value must be explicitly set to `null`. Implementing [the standard `PUT` behavior](https://httpwg.org/specs/rfc7231.html#PUT) is on the roadmap, follow [issue #4344] (<https://github.com/api-platform/core/issues/4344>) to track the progress.
4848

4949
## Enabling and Disabling Operations
5050

core/pagination.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -519,5 +519,6 @@ and if you want your results to be paginated, you will need to return an instanc
519519
`ApiPlatform\Core\DataProvider\PartialPaginatorInterface` or
520520
`ApiPlatform\Core\DataProvider\PaginatorInterface`.
521521
A few existing classes are provided to make it easier to paginate the results:
522+
522523
* `ApiPlatform\Core\DataProvider\ArrayPaginator`
523524
* `ApiPlatform\Core\DataProvider\TraversablePaginator`

distribution/debugging.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Note for Mac environments use the following:
6464
```
6565
6666
In VSCode, alongside the default PHP configuration in `launch.json`, you'll need path mappings for the Docker image.
67+
6768
```json
6869
{
6970
"version": "0.2.0",

0 commit comments

Comments
 (0)