Commit 658ee674 authored by iwakeh's avatar iwakeh 🌴
Browse files

Added links to examples. task-20566.

parent 24687a1a
Loading
Loading
Loading
Loading
+15 −10
Original line number Diff line number Diff line
@@ -2287,40 +2287,45 @@ rather than to find an Onionoo client that provides the desired
information.
</p>

<pre>https://onionoo.torproject.org/summary?limit=4</pre>

<p>
<code>https://onionoo.torproject.org/summary?limit=4</code>
(View result <a href="summary?limit=4">on this mirror</a>)<br/>

This first query returns the first four summary documents that Onionoo can
find.
The <code>limit</code> parameter should always be used while developing
new queries to avoid downloading huge responses.
</p>

<pre>https://onionoo.torproject.org/summary?limit=4&search=moria</pre>

<p>
<code>https://onionoo.torproject.org/summary?limit=4&search=moria</code>
(View result <a href="summary?limit=4&search=moria">on this mirror</a>)<br/>

The second query restricts results to relays and bridges containing the
string "moria" in one of a few searched fields.
</p>

<pre>https://onionoo.torproject.org/details?limit=4&search=moria</pre>

<p>
<code>https://onionoo.torproject.org/details?limit=4&search=moria</code>
(View result <a href="details?limit=4&search=moria">on this mirror</a>)<br/>

The third query switches from the short summary documents to the longer
details documents containing, well, more details.
</p>

<pre>https://onionoo.torproject.org/details?limit=4&search=moria&fields=nickname</pre>

<p>
<code>https://onionoo.torproject.org/details?limit=4&search=moria&fields=nickname</code>
(View result <a href="details?limit=4&search=moria&fields=nickname">on this mirror</a>)<br/>

The fourth query adds the <code>fields</code> parameter which removes all
fields except the specified ones from the result.
This parameter is only implemented for details documents.
</p>

<pre>https://onionoo.torproject.org/details?limit=4&search=moria&fields=nickname&order=-consensus_weight</pre>

<p>
<code>https://onionoo.torproject.org/details?limit=4&search=moria&fields=nickname&order=-consensus_weight</code>
(View result <a href="details?limit=4&search=moria&fields=nickname&order=-consensus_weight">on this mirror</a>)<br/>

The fifth query sorts results by relay consensus weight from largest to
smallest.
</p>