diff --git a/docs/glossary.rst b/docs/glossary.rst index c2870816a..57f92e111 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1,4 +1,3 @@ - .. index:: single: Glossary @@ -87,6 +86,18 @@ responsible for polling the Aviso server, and periodically processing the latest notifications. + The authentication credentials file is expected to be in JSON format, following the `ECMWF Web API `_: + + .. code-block:: json + + { + "url" : "https://api.ecmwf.int/v1", + "key" : "", + "email" : "" + } + + Only the fields :code:`url`, :code:`key`, and :code:`email` are required; any additional fields are ignored. + check point The check point file is like the :term:`suite definition`, but includes all the state information. @@ -1417,6 +1428,17 @@ responsible for polling the remote ecFlow server, and periodically synchronise node status. + The authentication credentials file is expected to be in JSON, according to the following format: + + .. code-block:: json + + { + "username" : "", + "password" : "", + } + + Only the fields :code:`username`, and :code:`password` are required; any additional fields are ignored. + node :term:`suite`, :term:`family` and :term:`task` form a hierarchy. Where a :term:`suite` serves as the root of the hierarchy.