Document the search API's _id parameter

hypothesis · Oct 7, 2015 · 089b377 · 089b377
1 parent 227efd6
commit 089b377
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -162,12 +162,21 @@ search
    ``/api/search?tags=climate&tags=feedback`` will find all annotations that
    have *either* tag "climate" *or* "feedback".
 
+   To retrieve a single annotation by ID it's best to use the
+   :ref:`read API <read API>`.
+   You can also do it using the search API but you must use ``_id`` instead of
+   ``id``::
+
+       /api/search?_id=AVAqBdTCiSJM1mYBTinl
+
    :reqheader Accept: desired response content type
    :resheader Content-Type: response content type
    :statuscode 200: no error
    :statuscode 400: errors parsing your query
 
 
+.. _read API:
+
 read
 ----