From 015ebb5c278e8009ab841e81323fcb51696247e9 Mon Sep 17 00:00:00 2001
From: jonmv <venstad@gmail.com>
Date: Mon, 25 Sep 2023 09:26:44 +0200
Subject: [PATCH] Document /doc/v1/ includeRemoves

---
 en/reference/document-v1-api-reference.html | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/en/reference/document-v1-api-reference.html b/en/reference/document-v1-api-reference.html
index 03f0d8234d..d8c0e62ca6 100644
--- a/en/reference/document-v1-api-reference.html
+++ b/en/reference/document-v1-api-reference.html
@@ -133,6 +133,7 @@ <h2 id="http-requests">HTTP requests</h2>
         <li><a href="#wanteddocumentcount">wantedDocumentCount</a></li>
         <li><a href="#fromtimestamp">fromTimestamp</a></li>
         <li><a href="#totimestamp">toTimestamp</a></li>
+        <li><a href="#includeRemoves">includeRemoves</a></li>
       </ul>
     </td>
   </tr>
@@ -590,6 +591,21 @@ <h2 id="request-parameters">Request parameters</h2>
       greater than, or equal to, <code>fromTimestamp</code>.
     </p>
   </td>
+</tr><tr>
+  <th>includeRemoves</th>
+  <td>Boolean</td>
+  <td>
+    <p id="includeRemoves">
+      Include recently removed document IDs, along with the set of returned documents.
+      By default, only documents currently present in the corpus are returned in the
+      <code>"documents"</code> array of the response; when this parameter is set to
+      <code>"true"</code>, documents that were recently removed, and whose tombstones
+      still exist, are also included in that array, as entries on the form
+      <code>{ "remove": "id:ns:type::foobar" }</code>. See
+      <a href="https://docs.vespa.ai/en/operations/admin-procedures.html#data-retention-vs-size">here</a>
+      for specifics on tombstones, including their lifetime. 
+    </p>
+  </td>
 </tr>
 </tbody>
 </table>