Added upgrade guide

index.rst

@@ -47,6 +47,16 @@ Plugins offer developers an easy way of adapting and extending an endpoint.
 
 .. include:: /plugins/map.rst.inc
 
+Upgrading
+---------
+
+.. toctree::
+   :hidden:
+
+   upgrading/index
+
+.. include:: /upgrading/map.rst.inc
+
 FAQ (Frequently Asked Questions)
 --------------------------------
 

upgrading/4-to-5.rst

@@ -0,0 +1,11 @@
+Version 4 to 5
+==============
+
+A few public things changed. That's why the creation of another major version was required.
+
+* The ``$connector`` dependency in ``Jtl\Connector\Core\Application\Application`` class moved from constructor to ``run()`` method. In this way an application can get instantiated without any knowledge about a specific connector.
+* The properties ``$request`` and ``$response`` in ``Jtl\Connector\Core\Application\Application`` class were renamed to ``$httpRequest`` and ``$httpResponse``, due to better understanding. So the method ``setRequest()`` was changed to ``setHttpRequest()`` as well.
+* The method ``addIdentificationString()`` was replaced by ``setIdentificationString()`` and ``setIdentificationStringBySubject()`` and the ``$mainLanguageIso`` argument on the ``getIdentificationStrings()`` method was removed in ``Jtl\Connector\Core\Model\AbstractModel``.
+* The optional argument ``$mainLanguageIso`` in the ``getIdentificationStrings()`` method was removed in ``Jtl\Connector\Core\Model\AbstractModel``. First available translation will be taken instead.
+* All classes from the ``Jtl\Connector\Core\Type`` namespace were removed and replaced by reflection.
+* Use of the class ``Jtl\Connector\Core\Model\TranslatableAttribute`` was simplified. A new property `type` was added, for being able to cast attribute values. Available types are `bool`, `float`, `int`, `json` and `string` (default). Actually the `type` property can be set only in the code. Idea is that `type` property can be set by JTL-Wawi in future.

upgrading/index.rst

@@ -0,0 +1,9 @@
+Upgrading
+=========
+
+.. toctree::
+    :hidden:
+
+    4-to-5
+
+.. include:: /upgrading/map.rst.inc

upgrading/map.rst.inc

@@ -0,0 +1 @@
+* :doc:`/upgrading/4-to-5`