DEPRECATE REST APIs

[wbloszyk]

Now we have a lot of problems with keeps APIs like:

• can not add support for symfony/config 5.x becouse nelmio/api-doc-bundle 2.x have config bug
• can not use nelmio/api-doc-bundle 4.x becouse it is in conflict
• nelmio/api-doc-bundle 2.x have not support symfony 5
• not all sonata bundles support nelmio 3.x

My solution is move APIs to seperate bundle or bundles. This will move all dependencies require to REST API to seperate bundle and allow us ignire it in 4.0 milestones.

For example:

• SonataMediaBundle will provide abstractMediaApiController
• In API bundle it will be extended with annotation for specify nelmio version
• 1.x - nelmio 2
• 2.x nelmio 3
• 3.x nelmio 4
• 4.x api platform
• or we can use only one version

IMO we should do it in one bundle sonata-project/api-bundle.

WDYT? @sonata-project/contributors

TODO:

Deprecate REST API in stable branch:

• SonataClassificationBundle
• SonataMediaBundle
• SonataNewsBundle
• SonataPageBundle
• SonataUserBundle

Remove REST API in unstable branch:

• SonataClassificationBundle
• SonataMediaBundle
• SonataNewsBundle
• SonataPageBundle
• SonataUserBundle

Bundles that we will not be deprecating the api (abandoned)

• ecomerce
• SonataNotificationBundle

[core23]

Which APIs do you mean? REST?

[core23]

My solution is move APIs to seperate bundle or bundles. This will move all dependencies require to REST API to seperate bundle and allow us ignire it in 4.0 milestones.

👍

IMO we should do it in one bundle sonata-project/api-bundle.

👎 This will bring other problems. If you just require api-bundle, it would install ALL bundles with an api or you will get some strange require-dev / conflict entries.

Might relate to this issue: #537

[wbloszyk]

IMO we should do it in one bundle sonata-project/api-bundle.

👎 This will bring other problems. If you just require api-bundle, it would install ALL bundles with an api or you will get some strange require-dev / conflict entries.

api-bundle will be in sugesstion section for each bundle where it is possible to use with conflict to set minimum api-bundle version.
in api-bundle we should add only conflict with minimum version. Require-dev can be ingore. Test can be provide by GitHub actions.

Might relate to this issue: #537

Simmilar but here dependencies are diffrence third part bundles. in admin dependencies are one ower bundle.

[VincentLanglet]

With @jordisala1991, we're currently discussing a lot about the Media bundle which has Rest API, and the issue with the duplicate code in datagridBundle and adminBundle.

In the media bundle

• If you don't use the rest API, you don't need the datagrid bundle. (Since Avoid using pager if not needed SonataMediaBundle#2041)
• If you only use the rest API, you don't need the admin-bundle.

If we split this, we have to

• Remove the usage of the PageableInterface in the original MediaBundle https://github.com/sonata-project/SonataMediaBundle/blob/master/src/Model/MediaManagerInterface.php#L23 (because it's used only for API)
• Remove the method getPager in the implementation
• Remove the datagridBundle dependency
• Decorate the MediaManager in the new MediaApiBundle to implements PageableInterface

It requires some work but would be a nice way to stop using datagridBundle in our admin-related bundles.

[VincentLanglet]

The new strategy is to deprecate the REST API sonata-project/SonataMediaBundle@e985c2c

We should list them all

[wbloszyk]

Updated.

[jordisala1991]

I remove ecommerce an NewsBundle, since they are abandoned and will not get major releases.

[VincentLanglet]

Deprecating/Removing the REST Api will allow to remove the datagrid-bundle dependency for the next majors.
We will be able to abandon it then as proposed in #1669

[VincentLanglet]

SonataNotification and SonataUser is not yet abandoned, so we should still deprecate the rest API

[wbloszyk]

SonataNotification and SonataUser is not yet abandoned, so we should still deprecate the rest API

We font wanna release these bundles in Sonata 4, so it is no reason to deprecate ReST API for them. They will be deprecated as whole bundle.

[VincentLanglet]

SonataNotification and SonataUser is not yet abandoned, so we should still deprecate the rest API

We dont wanna release these bundles in Sonata 4, so it is no reason to deprecate ReST API for them. They will be deprecated as whole bundle.

SonataNotification is not related to SonataAdmin, and a major could be created if needed if it helps people to migrate, dunno.
And the futur of SonataUser is not clear. So I cannot say there won't be any major first.
SonataNews was abandoned, and yet, there is still some PR on it.

Maybe they will be deprecated/abandoned, but currently there are not.

[VincentLanglet]

As far, UserBundle and Notification are not abandoned so we should still deprecate the rest API.
This will allow us to deprecate the DatagridBundle.

[VincentLanglet]

And as mention in #1714 (comment)

We should deprecate the API-Rest, all the method getPager and all the PageableManager extension.

[jordisala1991]

Do you think it is needed to deprecate NotificationBundle API? It will be deprecated when pagerbundle drops its usage (and it is required for next major)

Otherwise we can close this issue, the rest of the api are deprecated and removed.

[VincentLanglet]

Let's close it then.

[VincentLanglet]

There is sonata-project/SonataPageBundle#1238 to remove NotificationBundle from PageBundle