Skip to content

Commit 8b55afd

Browse files
committed
editing index
1 parent cff00eb commit 8b55afd

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

source/index.txt

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,9 @@ DataONE cyberinfrastructure.
1212
API Reference
1313
-------------
1414

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`.
1816

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`.
2118

2219
.. toctree::
2320
:maxdepth: 3
@@ -27,19 +24,12 @@ approach.
2724
apis/Exceptions
2825
apis/Types
2926
apis/rest_comms
30-
31-
Implementation Notes
32-
--------------------
33-
34-
.. toctree::
35-
:maxdepth: 2
3627

37-
implementation/index
38-
39-
4028
Design Documents
4129
----------------
4230

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.
32+
4333
.. toctree::
4434
:maxdepth: 1
4535

@@ -53,7 +43,6 @@ Design Documents
5343
.. toctree::
5444
:maxdepth: 1
5545

56-
Design Documents <design/index>
5746
design/NodeIdentity
5847
design/WhatIsData
5948
design/DataPackage
@@ -98,6 +87,16 @@ Notes and Miscellanea
9887
changelog
9988

10089

90+
Implementation Notes
91+
--------------------
92+
93+
.. toctree::
94+
:maxdepth: 2
95+
96+
implementation/index
97+
98+
99+
101100
Indices, Tables, and Change Log
102101
-------------------------------
103102

0 commit comments

Comments
 (0)