Skip to content

Commit 3a6ffae

Browse files
docs(extensions): explain better current support (#2074)
1 parent 83c8397 commit 3a6ffae

File tree

3 files changed

+13
-8
lines changed

3 files changed

+13
-8
lines changed

core/extensions.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Extensions
1+
# Extensions for Doctrine and Elasticsearch
2+
3+
> [!WARNING]
4+
> This is not yet available with [Eloquent](https://laravel.com/docs/eloquent), you're welcome to contribute [on GitHub](https://github.com/api-platform/core)
25
36
API Platform provides a system to extend queries on items and collections.
47

@@ -127,7 +130,7 @@ Note that your extensions should have a positive priority if defined. Internal e
127130
| `api_platform.doctrine.orm.query_extension.order` | -32 | ApiPlatform\Doctrine\Orm\Extension\OrderExtension |
128131
| `api_platform.doctrine.orm.query_extension.pagination` | -64 | ApiPlatform\Doctrine\Orm\Extension\PaginationExtension |
129132

130-
#### Blocking Anonymous Users
133+
#### Blocking Anonymous Users using Symfony
131134

132135
This example adds a `WHERE` clause condition only when a fully authenticated user without `ROLE_ADMIN` tries to access a resource. It means that anonymous users will be able to access all data. To prevent this potential security issue, the API must ensure that the current user is authenticated.
133136

core/graphql.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ composer require api-platform/graphql
1919
You can now use GraphQL at the endpoint: `https://localhost:8443/graphql`.
2020

2121
> [!NOTE]
22-
> If you used [the Symfony Variant thanks to Symfony Flex](../symfony/index.md#using-symfony-flex-and-composer-advanced-users) or the Laravel variant, URLs will be prefixed with `/api` by default. For example, the GraphQL endpoint will be: `https://localhost:8443/api/graphql`.
22+
> If you used [the Symfony Variant thanks to Symfony Flex](../symfony/index.md#installing-the-framework)
23+
> or the Laravel variant, URLs will be prefixed with `/api` by default. For example, the GraphQL endpoint will be: `https://localhost:8443/api/graphql`.
2324
2425
## Changing Location of the GraphQL Endpoint
2526

@@ -138,7 +139,7 @@ api_platform:
138139
### Disable GraphQL Playground with Laravel
139140

140141
> [!WARNING]
141-
> This is not yet available with Laravel, you're welcome to contribute [on Github](github.com/api-platform/core)
142+
> This is not yet available with Laravel, you're welcome to contribute [on GitHub](https://github.com/api-platform/core)
142143

143144
### Add another Location for GraphQL Playground
144145

@@ -1100,7 +1101,7 @@ resources:
11001101

11011102
### Syntax for Filters with a List of Key / Value Arguments
11021103

1103-
Some filters like the [exists filter](filters.md#exists-filter) or the [order filter](filters.md#order-filter-sorting) take a list of key / value as arguments.
1104+
Some filters like the [exists filter](doctrine-filters.md#exists-filter) or the [order filter](doctrine-filters.md#order-filter-sorting) take a list of key / value as arguments.
11041105

11051106
The first syntax coming to mind to use them is to write:
11061107

@@ -1387,7 +1388,8 @@ resources:
13871388

13881389
</code-selector>
13891390

1390-
Once enabled, a `page` filter will be available in the collection query (its name [can be changed in the configuration](pagination.md)) and an `itemsPerPage` filter will be available too if [client-side-pagination](pagination.md#client-side) is enabled.
1391+
Once enabled, a `page` filter will be available in the collection query (its name [can be changed in the configuration](pagination.md))
1392+
and an `itemsPerPage` filter will be available too if [client-side-pagination](pagination.md#changing-the-number-of-items-per-page-for-a-specific-resource) is enabled.
13911393

13921394
A `paginationInfo` field can be queried to obtain the following information:
13931395

@@ -2812,7 +2814,7 @@ final class BookContextBuilder implements SerializerContextBuilderInterface
28122814
## Export the Schema in SDL
28132815

28142816
> [!WARNING]
2815-
> This command is not yet available with Laravel, you're welcome to contribute [on Github](github.com/api-platform/core)
2817+
> This command is not yet available with Laravel, you're welcome to contribute [on GitHub](https://github.com/api-platform/core)
28162818

28172819
You may need to export your schema in SDL (Schema Definition Language) to import it in some tools.
28182820

core/subresources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ class Company {
348348
## Security
349349

350350
> [!WARNING]
351-
> This is not yet available with Laravel, you're welcome to contribute [on Github](github.com/api-platform/core)
351+
> This is not yet available with Laravel, you're welcome to contribute [on GitHub](https://github.com/api-platform/core)
352352
353353
In order to use Symfony's built-in security system on subresources the security option of the `Link` attribute can be used.
354354

0 commit comments

Comments
 (0)