You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/glossary.rst
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,3 @@
1
-
2
1
.. index::
3
2
single: Glossary
4
3
@@ -87,6 +86,18 @@
87
86
responsible for polling the Aviso server, and periodically processing the
88
87
latest notifications.
89
88
89
+
The authentication credentials file is expected to be in JSON format, following the `ECMWF Web API <https://www.ecmwf.int/en/computing/software/ecmwf-web-api>`_:
90
+
91
+
.. code-block:: json
92
+
93
+
{
94
+
"url" : "https://api.ecmwf.int/v1",
95
+
"key" : "<your-api-key>",
96
+
"email" : "<your-email>"
97
+
}
98
+
99
+
Only the fields :code:`url`, :code:`key`, and :code:`email` are required; any additional fields are ignored.
100
+
90
101
check point
91
102
The check point file is like the :term:`suite definition`, but includes all the state information.
92
103
@@ -1417,6 +1428,17 @@
1417
1428
responsible for polling the remote ecFlow server, and periodically
1418
1429
synchronise node status.
1419
1430
1431
+
The authentication credentials file is expected to be in JSON, according to the following format:
1432
+
1433
+
.. code-block:: json
1434
+
1435
+
{
1436
+
"username" : "<your-username>",
1437
+
"password" : "<your-password>",
1438
+
}
1439
+
1440
+
Only the fields :code:`username`, and :code:`password` are required; any additional fields are ignored.
1441
+
1420
1442
node
1421
1443
:term:`suite`, :term:`family` and :term:`task` form a hierarchy.
1422
1444
Where a :term:`suite` serves as the root of the hierarchy.
0 commit comments