Skip to content

Add optional limit parameter to suggest queries (#182) #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fsteeg merged 4 commits into from
Jul 10, 2025
Merged

Add optional limit parameter to suggest queries (#182) #193

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5cd6f5f
Add optional `limit` parameter to suggest queries (#182)
fsteeg Jun 12, 2025
091364c
Rename `cursor` query parameter to `offset` (#182)
fsteeg Jul 10, 2025
95e0f0f
Add example to suggest queries section (#182)
fsteeg Jul 10, 2025
83bac12
Update version history for changes to suggest query params (#182)
fsteeg Jul 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion 1.0-draft/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ <h4>This draft: 1.0-draft</h4>
<li><a href="https://github.com/reconciliation-api/specs/pull/149">Move the <code>query</code> field of reconciliation queries inside <code>properties</code> to allow for queries which do not provide entity names</a></li>
<li><a href="https://github.com/reconciliation-api/specs/pull/156">Add optional <code>standardizedScore</code> field to the manifest</a></li>
<li><a href="https://github.com/reconciliation-api/specs/pull/166">Unify naming to camelCase convention</a></li>
<li><a href="https://github.com/reconciliation-api/specs/pull/193">Add <code>limit</code> parameter to suggest queries and rename <code>cursor</code> to <code>offset</code></a></li>
</ul>
</section>
</section>
Expand Down Expand Up @@ -742,10 +743,15 @@ <h3>Suggest Queries</h3>
<dd>The string input by the user in the auto-suggest-enabled field;
depending on the data users are working with, they might want to select a suggestion from all available <a>types</a>, <a>properties</a>, or even <a>entities</a>;
to allow that, services MAY send all suggestions if the prefix is empty, and clients SHOULD provide a way to send the empty prefix;</dd>
<dt><code>cursor</code></dt>
<dt><code>limit</code></dt>
<dd>An optional integer to specify the number of suggestions to return.</dd>
<dt><code>offset</code></dt>
<dd>An optional integer to specify the number of suggestions to skip: this can be used by clients to fetch more suggestions.</dd>
</dl>
</p>
<p>
<pre class="example nohighlight">GET /suggest/entity?prefix=cumulo&amp;limit=3</pre>
</p>
</section>
<section id="suggest-responses">
<h3>Suggest Responses</h3>
Expand Down