mirror of
https://github.com/Sylius/Sylius.git
synced 2026-07-14 09:02:12 +00:00
[docs] dismount api docs
This commit is contained in:
Adam Kasperczak
parent
0320c0b401
commit
8883d918df
17 changed files with 44 additions and 45 deletions
|
|
@ -1 +0,0 @@
|
|||
* :doc:`/api/unified_api/index`
|
||||
|
|
@ -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
|
||||
|
|
@ -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`
|
||||
|
|
@ -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 <https://github.com/Sylius/ShopApiPlugin>`_ is an official plugin, providing customer-centered API.
|
||||
|
||||
Follow the `API reference <https://app.swaggerhub.com/apis/Sylius/sylius-shop-api/1.0.0>`_ for more details.
|
||||
3
docs/book/api/map.rst.inc
Normal file
3
docs/book/api/map.rst.inc
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
* :doc:`/book/api/introduction`
|
||||
* :doc:`/book/api/authorization`
|
||||
* :doc:`/book/api/sylius_api_paths`
|
||||
|
|
@ -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 </api/index>`.
|
||||
Read more about our REST API in the :doc:`Sylius API Guide </book/api/index>`.
|
||||
|
||||
.. tip::
|
||||
|
||||
|
|
|
|||
|
|
@ -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 </bdd/index>`.
|
||||
|
||||
* ``[API]`` when you are contributing docs to :doc:`the API guide </api/index>`.
|
||||
* ``[API]`` when you are contributing docs to :doc:`the API guide </book/api/index>`.
|
||||
|
||||
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``.
|
||||
|
|
|
|||
|
|
@ -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 </book/organization/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 <https://github.com/lexik/LexikJWTAuthenticationBundle/blob/master/Resources/doc/index.md#generate-the-ssh-keys/>`_
|
||||
|
||||
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
|
||||
------
|
||||
|
||||
|
|
|
|||
|
|
@ -10,3 +10,4 @@
|
|||
* :doc:`/book/organization/index`
|
||||
* :doc:`/book/support/index`
|
||||
* :doc:`/book/contributing/index`
|
||||
* :doc:`/book/api/index`
|
||||
|
|
|
|||
1
docs/cookbook/api/map.rst.inc
Normal file
1
docs/cookbook/api/map.rst.inc
Normal file
|
|
@ -0,0 +1 @@
|
|||
* :doc:`/cookbook/api/add_to_cart_product_chosen_by_product_options`
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -236,4 +236,4 @@ Learn more
|
|||
* :doc:`Checkout </book/orders/checkout>`
|
||||
* :doc:`Orders </book/orders/orders>`
|
||||
* :doc:`Adjustments </book/orders/adjustments>`
|
||||
* :doc:`Unified API </api/index>`
|
||||
* :doc:`Unified API </book/api/index>`
|
||||
|
|
|
|||
|
|
@ -71,18 +71,6 @@ The Cookbook
|
|||
|
||||
cookbook/index
|
||||
|
||||
The Sylius API
|
||||
--------------
|
||||
|
||||
In :doc:`the Sylius API chapter </api/index>` 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
|
||||
-------------
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue