kenaug74/Sylius
1
0
Fork 0
mirror of https://github.com/Sylius/Sylius.git synced 2026-07-14 09:02:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

doc: Adding a tip about api's preventing methods beside GET to load non cart orders by default

Browse source
This commit is contained in:
De Cramer Oliver 2024-10-16 20:03:33 +02:00 • committed by GitHub
parent 7f7f7b06c1
commit 81a658cc71
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/customization/api/adding_and_removing_endpoints.rst
View file

@ -23,6 +23,13 @@ And that's all, now you have a new endpoint with your custom logic.
Read more about API Platform endpoint configuration `here <https://api-platform.com/docs/core/operations/>`_
Good to Know
~~~~~~~~~~~~
.. tip::
Api Platform is configured to prevent modifications to orders not in the ``cart`` state. There is only a few specific actions allowed. This is done by preventing orders not in the state ``cart`` from loading if the api's method is not ``GET``. So if you need to add an endpoint to an api that needs to edit orders that are not in the state ``cart`` you will need to whitelist your api. This can be done by adding your api's route to the ``sylius.api.doctrine_extension.order_shop_user_item.filter_cart.allowed_non_get_operations`` parameter.
How to remove an endpoint?
--------------------------