Skip to content

Commit

Permalink
[ci skip] Updating documents
Browse files Browse the repository at this point in the history
  • Loading branch information
ci-build committed Aug 11, 2023
1 parent 286ef47 commit 686d82a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions additional-documentation/rest-api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1030,8 +1030,8 @@
<span class="hljs-string">"records"</span>
]</span>,
"<span class="hljs-attribute">additionalProperties</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="user-management" class="resource-group"><h2 class="group-heading">User Management <a href="#user-management" class="permalink">&para;</a></h2><div id="user-management-user-management-actions" class="resource"><h3 class="resource-heading">User Management Actions <a href="#user-management-user-management-actions" class="permalink">&nbsp;&para;</a></h3><div id="user-management-user-management-actions-get" class="action get"><h4 class="action-heading"><div class="name">List users in the system</div><a href="#user-management-user-management-actions-get" class="method get">GET</a><code class="uri">/default/rdmp/api/users{?searchBy,query,start,rows}</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">https://demo.redboxresearchdata.com.au</span>/default/rdmp/api/users?<span class="hljs-attribute">searchBy=</span><span class="hljs-literal">type</span>&<span class="hljs-attribute">query=</span><span class="hljs-literal">local</span>&<span class="hljs-attribute">start=</span><span class="hljs-literal">0</span>&<span class="hljs-attribute">rows=</span><span class="hljs-literal">10</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>start</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>0</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>0</span></span><p>The index number for the first value to return from the result set.</p>
</dd><dt>rows</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>10</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>10</span></span><p>The number of records to return in the request</p>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="user-management" class="resource-group"><h2 class="group-heading">User Management <a href="#user-management" class="permalink">&para;</a></h2><div id="user-management-user-management-actions" class="resource"><h3 class="resource-heading">User Management Actions <a href="#user-management-user-management-actions" class="permalink">&nbsp;&para;</a></h3><div id="user-management-user-management-actions-get" class="action get"><h4 class="action-heading"><div class="name">List users in the system</div><a href="#user-management-user-management-actions-get" class="method get">GET</a><code class="uri">/default/rdmp/api/users{?searchBy,query,page,pageSize}</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">https://demo.redboxresearchdata.com.au</span>/default/rdmp/api/users?<span class="hljs-attribute">searchBy=</span><span class="hljs-literal">type</span>&<span class="hljs-attribute">query=</span><span class="hljs-literal">local</span>&<span class="hljs-attribute">page=</span><span class="hljs-literal">1</span>&<span class="hljs-attribute">pageSize=</span><span class="hljs-literal">10</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>page</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>1</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>1</span></span><p>The page index of the result set to show.</p>
</dd><dt>pageSize</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>10</span></span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>10</span></span><p>The number of records to return in a page</p>
</dd><dt>searchBy</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>type</span></span><p>The attribute to search by. e.g. email</p>
</dd><dt>query</dt><dd><code>string</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>local</span></span><p>The value to query. Only exact matches.</p>
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Bearer abcabcab-abca-abca-abca-abcabcabcabc</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
Expand Down Expand Up @@ -1608,7 +1608,7 @@
"<span class="hljs-attribute">additionalProperties</span>": <span class="hljs-value"><span class="hljs-literal">false</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="mint-search-mint-records" class="resource"><h3 class="resource-heading">Search Mint records <a href="#mint-search-mint-records" class="permalink">&nbsp;&para;</a></h3><p>This endpoint is an authenticated wrapper to Apache solr’s search endpoint and supports all the <a href="https://solr.apache.org/guide/6_6/common-query-parameters.html">basic common query parameters</a>.</p>
<div id="mint-search-mint-records-get" class="action get"><h4 class="action-heading"><div class="name">Search</div><a href="#mint-search-mint-records-get" class="method get">GET</a><code class="uri">/mint/api/v1.1/search{?q}</code></h4><h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">https://demo.redboxresearchdata.com.au</span>/mint/api/v1.1/search?<span class="hljs-attribute">q=</span><span class="hljs-literal">query</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>q</dt><dd><code>string</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>query</span></span><p>The search string to query the index.</p>
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Bearer abcabcab-abca-abca-abca-abcabcabcabc</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 04 Aug 2023</p><script>/* eslint-env browser */
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Authorization</span>: <span class="hljs-string">Bearer abcabcab-abca-abca-abca-abcabcabcabc</span></code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 11 Aug 2023</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */
'use strict';

Expand Down

0 comments on commit 686d82a

Please sign in to comment.