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: source/index.txt
+14-15Lines changed: 14 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -12,12 +12,9 @@ DataONE cyberinfrastructure.
12
12
API Reference
13
13
-------------
14
14
15
-
The Application Programming Interfaces (APIs) for DataONE are described here.
16
-
APIs are exposed by the DataONE Coordinating Nodes (Coordinating Node APIs)
17
-
and data repositories participating as Member Nodes (Member Node APIs).
15
+
Components of the DataONE infrastructure interact through the DataONE APIs. Participating data repositories expose the :doc:`apis/MN_APIs` and Coordinating Nodes expose the :doc:`apis/CN_APIs`.
18
16
19
-
All API interactions occur over HTTPS with XML encoded messaged and a RESTful
20
-
approach.
17
+
API service endpoints use a restful pattern. All API interactions occur over HTTPS with XML encoded messages. The XML messages are defined by the :doc:`DataONE Types XML Schema<apis/Types>`. :doc:`apis/Exceptions` are cast to applicable HTTP error codes, with the response body containing an XML representation of the error. The RESTful implementation is more fully described in the :doc:`apis/rest_comms`.
21
18
22
19
.. toctree::
23
20
:maxdepth: 3
@@ -27,19 +24,12 @@ approach.
27
24
apis/Exceptions
28
25
apis/Types
29
26
apis/rest_comms
30
-
31
-
Implementation Notes
32
-
--------------------
33
-
34
-
.. toctree::
35
-
:maxdepth: 2
36
27
37
-
implementation/index
38
-
39
-
40
28
Design Documents
41
29
----------------
42
30
31
+
The design documents describe the intended functionality of the DataONE infrastructure. :doc:`design/userscenarios` provide a functional overview from a user perspective. :doc:`design/usecases` provides a more detailed view of how the APIs are used to support specific component interactions.
0 commit comments