Updated documentation

GermanoGuerrini · Feb 26, 2024 · 74791f4 · 74791f4
1 parent 627daf6
commit 74791f4
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 9 deletions.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -1,6 +1,10 @@
 Changelog
 =========
 
+Version 2.0
+-----------
+* Updated version compatible with HDA v2
+
 Version 1.13
 -------------
 * Minor documentation fixes

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,6 +10,14 @@ Documentation about its usage can be found at `WEkEO website <https://www.wekeo.
 Check out the :doc:`usage </usage>` section for further information, including
 how to :doc:`install </installation>` the project.
 
+.. warning::
+   The latest version only supports HDA v2. If you need to interact with HDA v1, please refer to version 1.14, which is the last compatible one.
+   Keep in mind that HDA v1 will be decommissioned in Q2 2024.
+
+   While v2 is a complete overhaul of the previous version, the client interface is identical in both versions.
+   The most notable change is the query format, that has been greatly simplified.
+   The client, though, is still accepting the old format when possible, converting the query into the new one.
+
 Requirements
 ------------
 - Python 3

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -4,13 +4,12 @@ Installation
 Get your credentials
 --------------------
 
-1. If you don't have a WEkEO account, please self register at the WEkEO `registration page <https://www.wekeo.eu/web/guest/user-registration>`_, then proceed to the step below.
+1. If you don't have a WEkEO account, please self register through the WEkEO `registration form <https://www.wekeo.eu/>`_, then proceed to the step below.
 
 2. Copy the code below in the file `$HOME/.hdarc` in your Unix/Linux environment. Adapt the following template with the credentials of your WEkEO account:
 
     .. code-block:: ini
 
-        url: https://wekeo-broker.apps.mercator.dpi.wekeo.eu/databroker
         user: [username]
         password: [password]
 

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -17,13 +17,9 @@ The client can be used directly into another python script as in the following e
     c = Client()
 
     query = {
-        "datasetId": "EO:EUM:DAT:SENTINEL-3:OL_1_EFR___",
-        "dateRangeSelectValues": [{
-            "end": "2019-07-03T14:03:00.000Z",
-            "name": "dtrange",
-            "start": "2019-07-03T13:59:00.000Z"
-        }],
-        "stringChoiceValues": []
+        'dataset_id': 'EO:EUM:DAT:SENTINEL-3:OL_1_EFR___',
+        'dtstart': '2023-07-03T13:59:00.000Z',
+        'dtend': '2023-07-03T14:03:00.000Z',
     }
     matches = c.search(query)
     print(matches)
@@ -33,4 +29,9 @@ The client can be used directly into another python script as in the following e
     The query must be a json valid object.
     Please refer to the official documentation of the HDA for instructions on how to get the list of the available parameters.
 
+.. warning::
+    The query format has been streamlined in version 2, but the client still accepts most of the old queries and automatically
+    convert them into the new format under the hood, before they are submitted to the API.
+    You might still want to explicitly change the queries to reflect the updated structure.
+
 Alternatively, it can be wrapped into a script to be executed from the command line. Please refer to the ``demos/demo.py`` file for a simple demostration.