Skip to content

Commit 3254b46

Browse files
Merge pull request #1573 from vincentchalamon/docs/links
fix: links to main
2 parents 815fcfe + cd9b528 commit 3254b46

File tree

10 files changed

+12
-92
lines changed

10 files changed

+12
-92
lines changed

core/configuration.md

Lines changed: 0 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,6 @@ api_platform:
2727
# Specify a path name generator to use.
2828
path_segment_name_generator: 'api_platform.path_segment_name_generator.underscore'
2929

30-
# Allow using plain IDs for JSON format.
31-
# Deprecated since API Platform 2.7, will be removed in API Platform 3.0
32-
allow_plain_identifiers: false
33-
3430
validator:
3531
# Enable the serialization of payload fields when a validation error is thrown.
3632
# If you want to serialize only some payload fields, define them like this: [ severity, anotherPayloadField ]
@@ -54,14 +50,6 @@ api_platform:
5450
# If disabled, it will only join relations having the EAGER fetch mode.
5551
force_eager: true
5652

57-
# Enabling the FOSUserBundle integration has been deprecated in 2.5 and will be removed in 3.0.
58-
# Enable the FOSUserBundle integration.
59-
enable_fos_user: false
60-
61-
# Enabling the NelmioApiDocBundle integration has been deprecated in 2.2 and will be removed in 3.0.
62-
# NelmioApiDocBundle 3 has native support for API Platform.
63-
enable_nelmio_api_doc: false
64-
6553
# Enable the Swagger documentation and export.
6654
enable_swagger: true
6755

@@ -103,35 +91,6 @@ api_platform:
10391
# The name of the query parameter to enable or disable the partial pagination.
10492
partial_parameter_name: 'partial'
10593

106-
# To enable or disable pagination for all resource collections by default.
107-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_enabled instead.
108-
enabled: true
109-
110-
# To allow partial pagination for all resource collections.
111-
# This improves performances by skipping the `COUNT` query.
112-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_partial instead.
113-
partial: false
114-
115-
# To allow the client to enable or disable the pagination.
116-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_client_enabled instead.
117-
client_enabled: false
118-
119-
# To allow the client to set the number of items per page.
120-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_client_items_per_page instead.
121-
client_items_per_page: false
122-
123-
# To allow the client to enable or disable the partial pagination.
124-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_client_partial instead.
125-
client_partial: false
126-
127-
# The default number of items per page.
128-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_items_per_page instead.
129-
items_per_page: 30
130-
131-
# The maximum number of items per page.
132-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.pagination_maximum_items_per_page instead.
133-
maximum_items_per_page: ~
134-
13594
mapping:
13695
# The list of paths with files or directories where the bundle will look for additional resource files.
13796
paths: []
@@ -256,22 +215,6 @@ api_platform:
256215
# Use another service as the purger for example "api_platform.http_cache.purger.varnish.xkey"
257216
purger: 'api_platform.http_cache.purger.varnish.ban'
258217

259-
# Automatically generate etags for API responses.
260-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.cache_headers.etag instead.
261-
etag: true
262-
263-
# Default value for the response max age.
264-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.cache_headers.max_age instead.
265-
max_age: 3600
266-
267-
# Default value for the response shared (proxy) max age.
268-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.cache_headers.shared_max_age instead.
269-
shared_max_age: 3600
270-
271-
# Default values of the "Vary" HTTP header.
272-
# Deprecated since 2.6 and will be removed in 3.0, use defaults.cache_headers.vary instead.
273-
vary: ['Accept']
274-
275218
mercure:
276219
# Enabled by default with installed symfony/mercure-bundle.
277220
enabled: false

core/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Attribute | Type | Default | Description
6161

6262
Registering your own event listeners to add extra logic is convenient.
6363

64-
The [`ApiPlatform\Core\EventListener\EventPriorities`](https://github.com/api-platform/core/blob/2.6/src/EventListener/EventPriorities.php) class comes with a convenient set of class constants corresponding to commonly used priorities:
64+
The [`ApiPlatform\Core\EventListener\EventPriorities`](https://github.com/api-platform/core/blob/main/src/Symfony/EventListener/EventPriorities.php) class comes with a convenient set of class constants corresponding to commonly used priorities:
6565

6666
Constant | Event | Priority |
6767
-------------------|-------------------|----------|

core/filters.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -526,8 +526,6 @@ It will also check the emptiness of a collection association.
526526

527527
Syntax: `?exists[property]=<true|false|1|0>`
528528

529-
Previous syntax (deprecated): `?property[exists]=<true|false|1|0>`
530-
531529
Enable the filter:
532530

533531
[codeSelector]

core/fosuser-bundle.md

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
11
# FOSUserBundle Integration
22

3-
## ⚠️ Deprecated: this integration is deprecated and will be removed in API Platform 3
4-
5-
FOSUserBundle is not well suited for APIs. We strongly encourage you to use the [Doctrine user provider](https://symfony.com/doc/current/security/user_provider.html#entity-user-provider)
6-
shipped with Symfony or to [create a custom user provider](https://symfony.com/doc/current/security/user_provider.html#creating-a-custom-user-provider)
7-
instead of using this bundle.
8-
9-
API Platform is shipped with a bridge for [FOSUserBundle](https://github.com/FriendsOfSymfony/FOSUserBundle).
10-
If the FOSUser bundle is enabled, this bridge will use its `UserManager` to create, update and delete user resources.
11-
12-
<p align="center" class="symfonycasts"><a href="https://symfonycasts.com/screencast/api-platform/user-entity?cid=apip"><img src="../distribution/images/symfonycasts-player.png" alt="User Entity screencast"><br>Watch the User Entity screencast</a></p>
13-
143
## Installing the Bundle
154

165
The installation procedure of the FOSUserBundle is described [in the main Symfony docs](https://symfony.com/doc/master/bundles/FOSUserBundle/index.html)
@@ -31,16 +20,6 @@ framework:
3120
form: { enabled: true }
3221
```
3322
34-
## Enabling the Bridge
35-
36-
To enable the provided bridge with FOSUserBundle, you need to add the following configuration to API Platform:
37-
38-
```yaml
39-
# api/config/packages/api_platform.yaml
40-
api_platform:
41-
enable_fos_user: true
42-
```
43-
4423
## Creating a `User` Entity with Serialization Groups
4524

4625
Here's an example of declaration of a [Doctrine ORM User class](https://github.com/FriendsOfSymfony/FOSUserBundle/blob/master/Resources/doc/index.rst#a-doctrine-orm-user-class).
@@ -65,7 +44,7 @@ use Symfony\Component\Serializer\Annotation\Groups;
6544
#[ORM\Entity]
6645
#[ORM\Table(name: 'fos_user')]
6746
#[ApiResource(
68-
normalizationContext: ['groups' => ['user', 'user:read']],
47+
normalizationContext: ['groups' => ['user']],
6948
denormalizationContext: ['groups' => ['user', 'user:write']],
7049
)]
7150
class User extends BaseUser

core/identifiers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@ final class Person
187187
API Platform supports the following identifier types:
188188

189189
- `scalar` (string, integer)
190-
- `\DateTime` (uses the symfony `DateTimeNormalizer` internally, see [DateTimeIdentifierNormalizer](https://github.com/api-platform/core/blob/main/src/Api/UuidUriVariableTransformer/DateTimeUriVariableTransformer.php))
191-
- `\Ramsey\Uuid\Uuid` (see [UuidNormalizer](https://github.com/api-platform/core/blob/main/src/RamseyUuid/UuidUriVariableTransformer/UuidUriVariableTransformer.php))
192-
- `\Symfony\Component\Uid\Ulid` (see [UlidNormalizer](https://github.com/api-platform/core/blob/main/src/Symfony/UuidUriVariableTransformer/UlidUriVariableTransformer.php))
193-
- `\Symfony\Component\Uid\Uuid` (see [UuidNormalizer](https://github.com/api-platform/core/blob/main/src/Symfony/UuidUriVariableTransformer/UuidUriVariableTransformer.php))
190+
- `\DateTime` (uses the symfony `DateTimeNormalizer` internally, see [DateTimeIdentifierNormalizer](https://github.com/api-platform/core/blob/main/src/Api/UriVariableTransformer/DateTimeUriVariableTransformer.php))
191+
- `\Ramsey\Uuid\Uuid` (see [UuidNormalizer](https://github.com/api-platform/core/blob/main/src/RamseyUuid/UriVariableTransformer/UuidUriVariableTransformer.php))
192+
- `\Symfony\Component\Uid\Ulid` (see [UlidNormalizer](https://github.com/api-platform/core/blob/main/src/Symfony/UriVariableTransformer/UlidUriVariableTransformer.php))
193+
- `\Symfony\Component\Uid\Uuid` (see [UuidNormalizer](https://github.com/api-platform/core/blob/main/src/Symfony/UriVariableTransformer/UuidUriVariableTransformer.php))

core/openapi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ As described [in the Symfony documentation](https://symfony.com/doc/current/temp
487487
</html>
488488
```
489489

490-
You may want to copy the [one shipped with API Platform](https://github.com/api-platform/core/blob/2.6/src/Bridge/Symfony/Bundle/Resources/views/SwaggerUi/index.html.twig) and customize it.
490+
You may want to copy the [one shipped with API Platform](https://github.com/api-platform/core/blob/main/src/Symfony/Bundle/Resources/views/SwaggerUi/index.html.twig) and customize it.
491491

492492
## Compatibility Layer with Amazon API Gateway
493493

core/pagination.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ To know more about cursor-based pagination take a look at [this blog post on med
342342

343343
## Controlling The Behavior of The Doctrine ORM Paginator
344344

345-
The [PaginationExtension](https://github.com/api-platform/core/blob/2.6/src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php) of API Platform performs some checks on the `QueryBuilder` to guess, in most common cases, the correct values to use when configuring the Doctrine ORM Paginator:
345+
The [PaginationExtension](https://github.com/api-platform/core/blob/main/src/Doctrine/Orm/Extension/PaginationExtension.php) of API Platform performs some checks on the `QueryBuilder` to guess, in most common cases, the correct values to use when configuring the Doctrine ORM Paginator:
346346

347347
* `$fetchJoinCollection` argument: Whether there is a join to a collection-valued association. When set to `true`, the Doctrine ORM Paginator will perform an additional query, in order to get the correct number of results.
348348

core/state-providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ bin/console make:state-provider
2929
Let's start with a State Provider for the URI: `/blog_posts/{id}`.
3030

3131
First, your `BlogPostProvider` has to implement the
32-
[`StateProviderInterface`](https://github.com/api-platform/core/blob/main/src/State/StateProviderInterface.php):
32+
[`ProviderInterface`](https://github.com/api-platform/core/blob/main/src/State/ProviderInterface.php):
3333

3434
```php
3535
<?php

core/validation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ For example, from [`Regex`](https://symfony.com/doc/4.4/reference/constraints/Re
552552
For building custom property schema based on custom validation constraints you can create a custom class
553553
for generating property scheme restriction.
554554

555-
To create property schema, you have to implement the [`PropertySchemaRestrictionMetadataInterface`](https://github.com/api-platform/core/blob/caca7f26b7f22a0abf84390463a1ea47c47d7757/src/Bridge/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaRestrictionMetadataInterface.php).
555+
To create property schema, you have to implement the [`PropertySchemaRestrictionMetadataInterface`](https://github.com/api-platform/core/blob/main/src/Symfony/Validator/Metadata/Property/Restriction/PropertySchemaRestrictionMetadataInterface.php).
556556
This interface defines only 2 methods:
557557

558558
* `create`: to create property schema

extra/releases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ API Platform follows the [Semantic Versioning](https://semver.org) strategy.
44

55
Only 3 versions are maintained at the same time:
66

7-
* **stable** (currently the **2.6** branch): regular bug fixes are integrated in this version
8-
* **old-stable** (currently **2.5** branch): security fixes are integrated in this version, regular bug fixes are **not** backported in it
7+
* **stable** (currently the **2.7** branch): regular bug fixes are integrated in this version
8+
* **old-stable** (currently **2.6** branch): security fixes are integrated in this version, regular bug fixes are **not** backported in it
99
* **development** (**main** branch): new features target this branch
1010

1111
Older versions (1.x, 2.0...) **are not maintained**. If you still use them, you must upgrade as soon as possible.

0 commit comments

Comments
 (0)