Skip to content

Commit

Permalink
Merge pull request #2902 from vespa-engine/jonmv/doc-v1-visit-removes
Browse files Browse the repository at this point in the history
Document /doc/v1/ includeRemoves
  • Loading branch information
jonmv authored Sep 25, 2023
2 parents d11e9b9 + 015ebb5 commit e677eec
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions en/reference/document-v1-api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down

0 comments on commit e677eec

Please sign in to comment.