gCubeSystem
/
gcat
15
0
Fork 0
Code Issues Pull Requests Releases 13 Wiki Activity

Improving documentation

This commit is contained in:
Luca Frosini 2022-09-16 12:42:58 +02:00
parent 42433c4007
commit 3455159ecc
1 changed files with 50 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
src/main/java/org/gcube/gcat/rest/Item.java
View File

@ -52,14 +52,62 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
* <h4>Filtering options</h4> * <h4>Filtering options</h4>
* <p> * <p>
* The listing method offers options to filter the results, thus enacting to search for items including spatial search (see ext_bbox below).<br/> * The listing method offers options to filter the results, thus enacting to search for items including spatial search (see ext_bbox below).<br/>
* It accepts the following query parameters (a subset of Solr search query parameters, see Solr Query Syntax): * </p>
* <dl>
* <dt>include_private (bool)</dt>
* <dd>
* <em>Optional</em>.<em>Default:false</em>.<br/>
* If True, private datasets will be included in the results.<br/>
* Only private datasets from the user’s 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>
* </dd>
*
* <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 <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 Catalog filtering 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>
* </p> * </p>
* *
* <h4>Solr based Filtering options</h4>
* <p>
* It accepts the following query parameters (a subset of Solr search query parameters, see Solr Query Syntax):
* </p>
* <dl> * <dl>
* <dt>q (string)</dt> * <dt>q (string)</dt>
* <dd> * <dd>
* <em>Optional</em>.<em>Default:"*:*"</em><br/> * <em>Optional</em>.<em>Default:"*:*"</em><br/>
* The solr query. see Solr Query Syntax<br/> * The solr query.<br/>
* E.g. <code>/items?q=title:foo</code> returns the items with word "foo" in the title.<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> * E.g. <code>/items?q=extras_systemtype:MyProfile</code> returns the items having the profile <em>MyProfile</em>
* </dd> * </dd>
@ -86,51 +134,7 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
* E.g. <code>/items?q=title:foo&sort=name+asc</code> returns the items with word "foo" in the 'title' * 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> * </dd>
*
* <dt>include_private (bool)</dt>
* <dd>
* <em>Optional</em>.<em>Default:false</em>.<br/>
* If True, private datasets will be included in the results.<br/>
* Only private datasets from the user’s 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>
* </dd>
*
* <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 <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> * <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. * @param limit To get unlimited results the limit query parameters must be set to -1.