diff --git a/docs/api/map.rst.inc b/docs/api/map.rst.inc deleted file mode 100644 index 3dc1199630..0000000000 --- a/docs/api/map.rst.inc +++ /dev/null @@ -1 +0,0 @@ -* :doc:`/api/unified_api/index` diff --git a/docs/api/unified_api/index.rst b/docs/api/unified_api/index.rst deleted file mode 100644 index 13da0e95b4..0000000000 --- a/docs/api/unified_api/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -The REST API Reference -====================== - -.. toctree:: - :hidden: - - introduction - authorization - sylius_api_paths - add_to_cart_product_chosen_by_product_options - -.. include:: /api/unified_api/map.rst.inc diff --git a/docs/api/unified_api/map.rst.inc b/docs/api/unified_api/map.rst.inc deleted file mode 100644 index 611787eb42..0000000000 --- a/docs/api/unified_api/map.rst.inc +++ /dev/null @@ -1,4 +0,0 @@ -* :doc:`/api/unified_api/introduction` -* :doc:`/api/unified_api/authorization` -* :doc:`/api/unified_api/sylius_api_paths` -* :doc:`/api/unified_api/add_to_cart_product_chosen_by_product_options` diff --git a/docs/api/unified_api/authorization.rst b/docs/book/api/authorization.rst similarity index 100% rename from docs/api/unified_api/authorization.rst rename to docs/book/api/authorization.rst diff --git a/docs/api/index.rst b/docs/book/api/index.rst similarity index 64% rename from docs/api/index.rst rename to docs/book/api/index.rst index f281f2cde4..6b36742596 100644 --- a/docs/api/index.rst +++ b/docs/book/api/index.rst @@ -1,8 +1,5 @@ -Sylius API -========== - -Unified API ------------ +API +=== .. warning:: @@ -16,13 +13,9 @@ This part of the documentation is about the currently developed unified API for .. toctree:: :hidden: - unified_api/index + introduction + authorization + sylius_api_paths -.. include:: /api/unified_api/map.rst.inc +.. include:: /book/api/map.rst.inc -Shop API --------- - -`Sylius Shop API `_ is an official plugin, providing customer-centered API. - -Follow the `API reference `_ for more details. diff --git a/docs/api/unified_api/introduction.rst b/docs/book/api/introduction.rst similarity index 100% rename from docs/api/unified_api/introduction.rst rename to docs/book/api/introduction.rst diff --git a/docs/book/api/map.rst.inc b/docs/book/api/map.rst.inc new file mode 100644 index 0000000000..1eb9d810e7 --- /dev/null +++ b/docs/book/api/map.rst.inc @@ -0,0 +1,3 @@ +* :doc:`/book/api/introduction` +* :doc:`/book/api/authorization` +* :doc:`/book/api/sylius_api_paths` diff --git a/docs/api/unified_api/sylius_api_paths.rst b/docs/book/api/sylius_api_paths.rst similarity index 100% rename from docs/api/unified_api/sylius_api_paths.rst rename to docs/book/api/sylius_api_paths.rst diff --git a/docs/book/architecture/architecture.rst b/docs/book/architecture/architecture.rst index dbbd5ed9d8..c28cc3f794 100644 --- a/docs/book/architecture/architecture.rst +++ b/docs/book/architecture/architecture.rst @@ -126,7 +126,7 @@ Api The API available in Sylius Core is called the **Admin API** as it is operating from the Admin perspective. Our API uses the REST approach. Since our controllers are format agnostic they have become reusable in the API. Therefore if you request products in the shop frontend you are using exactly the same action as when you are placing the api request. -Read more about our REST API in the :doc:`Sylius API Guide `. +Read more about our REST API in the :doc:`Sylius API Guide `. .. tip:: diff --git a/docs/book/contributing/documentation/overview.rst b/docs/book/contributing/documentation/overview.rst index ed2d44e5cf..f19d19917f 100644 --- a/docs/book/contributing/documentation/overview.rst +++ b/docs/book/contributing/documentation/overview.rst @@ -128,7 +128,7 @@ You can prefix the title of your pull request in a few cases: * ``[Behat]`` if you modify something in the :doc:`the BDD guide `. -* ``[API]`` when you are contributing docs to :doc:`the API guide `. +* ``[API]`` when you are contributing docs to :doc:`the API guide `. For instance if your pull request is about documentation of some feature of the Resource bundle, but it is still a work in progress it should look like : ``[WIP][Documentation][ResourceBundle] Arbitrary feature documentation``. diff --git a/docs/book/index.rst b/docs/book/index.rst index 6d422d057b..b8384b5bc3 100644 --- a/docs/book/index.rst +++ b/docs/book/index.rst @@ -96,6 +96,26 @@ You should also have a look here if you are looking for Cart, which is in Sylius .. include:: /book/orders/map.rst.inc +API +--- + +.. warning:: + + The new, unified Sylius API is still under development, that's why the whole ``ApiBundle`` is tagged with ``@experimental``. + This means that all code from ``ApiBundle`` is excluded from :doc:`Backward Compatibility Promise `. + +This chapter will explain to you how to start with our new API, show concepts used in it, and you will inform you why we have decided to rebuild entire api from scratch. +To use this API remember to generate JWT token. For more information, please visit `jwt package documentation `_ + +This part of the documentation is about the currently developed unified API for the Sylius platform. + +.. toctree:: + :hidden: + + api/index + +.. include:: /book/api/map.rst.inc + Themes ------ diff --git a/docs/book/map.rst.inc b/docs/book/map.rst.inc index 1db373e6bc..1f02065211 100644 --- a/docs/book/map.rst.inc +++ b/docs/book/map.rst.inc @@ -10,3 +10,4 @@ * :doc:`/book/organization/index` * :doc:`/book/support/index` * :doc:`/book/contributing/index` +* :doc:`/book/api/index` diff --git a/docs/api/unified_api/add_to_cart_product_chosen_by_product_options.rst b/docs/cookbook/api/add_to_cart_product_chosen_by_product_options.rst similarity index 100% rename from docs/api/unified_api/add_to_cart_product_chosen_by_product_options.rst rename to docs/cookbook/api/add_to_cart_product_chosen_by_product_options.rst diff --git a/docs/cookbook/api/map.rst.inc b/docs/cookbook/api/map.rst.inc new file mode 100644 index 0000000000..6db1ceb610 --- /dev/null +++ b/docs/cookbook/api/map.rst.inc @@ -0,0 +1 @@ +* :doc:`/cookbook/api/add_to_cart_product_chosen_by_product_options` diff --git a/docs/cookbook/index.rst b/docs/cookbook/index.rst index f95a647a57..c20378f108 100644 --- a/docs/cookbook/index.rst +++ b/docs/cookbook/index.rst @@ -152,3 +152,13 @@ Taxation taxation/customize-tax-by-address .. include:: /cookbook/taxation/map.rst.inc + +API +--- + +.. toctree:: + :hidden: + + api/add_to_cart_product_chosen_by_product_options + +.. include:: /cookbook/api/map.rst.inc diff --git a/docs/getting-started-with-sylius/custom-business-logic.rst b/docs/getting-started-with-sylius/custom-business-logic.rst index ebdf560c7f..b3459e9eef 100644 --- a/docs/getting-started-with-sylius/custom-business-logic.rst +++ b/docs/getting-started-with-sylius/custom-business-logic.rst @@ -236,4 +236,4 @@ Learn more * :doc:`Checkout ` * :doc:`Orders ` * :doc:`Adjustments ` -* :doc:`Unified API ` +* :doc:`Unified API ` diff --git a/docs/index.rst b/docs/index.rst index 6df7f7fb91..e875f81312 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -71,18 +71,6 @@ The Cookbook cookbook/index -The Sylius API --------------- - -In :doc:`the Sylius API chapter ` you'll understand both the new Sylius API and the old Admin API. - -.. toctree:: - :hidden: - - api/index - -.. include:: /api/map.rst.inc - The BDD Guide -------------