Improving documentation

This commit is contained in:
Luca Frosini 2022-09-16 12:37:06 +02:00
parent 7b2d9930a7
commit 42433c4007
1 changed files with 45 additions and 12 deletions

View File

@ -58,34 +58,39 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
* <dl>
* <dt>q (string)</dt>
* <dd>
* the solr query. Optional. Default: "*:*" See Solr Query Syntax.
* E.g. <code>/items?q=title:foo</code> returns the items with word "foo" in the title;
* <em>Optional</em>.<em>Default:"*:*"</em><br/>
* The solr query. see Solr Query Syntax<br/>
* E.g. <code>/items?q=title:foo</code> returns the items with word "foo" in the title.<br/>
* E.g. <code>/items?q=extras_systemtype:MyProfile</code> returns the items having the profile <em>MyProfile</em>
* </dd>
*
* <dt>fq (string)</dt>
* <dd>
* Filter query. A query string that limits the query results without influencing their scores.
* Note: <code>+site_id:{ckan_site_id}</code> is added to this string prior to the query being executed.<br/>
* E.g. <code>/items?q=title:foo&fq=notes:bar</code> returns with word "foo" in the 'title' and the word "bar" in the 'notes';
* <em>Optional</em>.<em>Default:null</em>.<br/>
* Filter query. A query string that limits the query results without influencing their scores.<br/>
* E.g. <code>/items?q=title:foo&fq=notes:bar</code> returns with word "foo" in the 'title' and the word "bar" in the 'notes'.
* </dd>
*
* <dt>fq_list (list of strings)</dt>
* <dd>
* additional filter queries to apply.<br/>
* E.g. <code>/items?q=title:foo&fq_list=...</code> returns the items with word "foo" in the 'title'
* <em>Optional</em>.<em>Default:null</em>.<br/>
* Additional filter queries to apply.<br/>
* E.g. <code>/items?q=title:foo&fq_list=...</code> returns the items with word "foo" in the 'title'.
* </dd>
*
* <dt>sort (string)</dt>
* <dd>
* sorting of the search results. Optional. Default: 'relevance asc, metadata_modified desc'.
* <em>Optional</em>.<em>Default:"relevance asc, metadata_modified desc"</em>.<br/>
* Sorting of the search results.<br/>
* As per the solr documentation, this is a comma-separated string of field names and sort-orderings.<br/>
* E.g. <code>/items?q=title:foo&sort=name+asc</code> returns the items with word "foo" in the 'title'
* sorting the results by name ascending;
* sorting the results by name ascending.
* </dd>
*
* <dt>include_private (bool)</dt>
* <dd>
* if True, private datasets will be included in the results.
* <em>Optional</em>.<em>Default:false</em>.<br/>
* If True, private datasets will be included in the results.<br/>
* Only private datasets from the users organizations will be returned. For the sysadmins will be returned all private datasets.
* Optional, the default is False.<br/>
* E.g. <code>/items?include_private=true</code>
@ -93,19 +98,47 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
*
* <dt>ext_bbox</dt>
* <dd>
* <em>Optional</em>.<em>Default:null</em>.<br/>
* The coordinates of the upper-right and bottom-left angle of a rectangular to query for.
* The form is Lat,Long,Lat,Long<br/>
* The form is <code>Lat,Long,Lat,Long</code><br/>
* E.g. <code>/items?limit=10&offset=0&q=Pollution&ext_bbox=-7.535093,49.208494,3.890688,57.372349</code>
* returns the first 10 items with 'Pollution' having a spatial coverage in the specified bounding box.
* </dd>
*
* <dt>own_only (bool)</dt>
* <dd>
* <em>Optional</em>.<em>Default:false</em>.<br/>
* If True, only the items of the requester user will be included in the result.<br/>
* E.g. <code>/items?limit=10&offset=0&own_only=true>
* </dd>
*
* <dt>all_fields</dt>
* <dd>
* <em>Optional</em>.<em>Default:false</em>.
* If True, the returned array list contains the whole item representation and not only the id (i.e. the name).
* E.g. <code>/items?limit=10&offset=0&all_fields=true</code>
* </dd>
*
* </dl>
*
* <h4>Moderated Catalogues options</h4>
* <dl>
* <dt>status (enum)</dt>
* <dd>
* <em>Optional</em>.<em>Default:null</em>.<br/>
* It has sense only for moderated catalogs.
* It can assume the following values: <code>pending</code>; <code>rejected</code>; <code>approved</code>.
* If null return both approved items and items which have been published before the activation of the moderation.
* </dd>
* </dl>
*
*
* @param limit To get unlimited results the limit query parameters must be set to -1.
* If the results are too much the operation could fail.
* It is recommended to request no more than 1000 results.
* @param offset The offset parameter indicates the starting position of the result.
* @param count It indicate that the result must contains only the total number of items of the query.
* @return It returns an array list of string containing the ids (i.e. names) of the items.<br/>
* @return It returns an array list of string containing the ids (i.e. names) of the items.
* E.g.<pre>["item0","items1",...,"item10"]</pre>
*
* In the case the query parameter <code>count=true</code> it returns the total number of items of the query.