Improving docs
This commit is contained in:
parent
a5aee6353e
commit
53af6be0b9
|
@ -187,18 +187,39 @@ Roles
|
|||
|
||||
The catalogue uses the following hierarchic roles:
|
||||
|
||||
* *Catalogue-Member*: a user with such a role is mainly capable of listing and reading items;
|
||||
* *Catalogue-Editor*: a user with such a role is capable of managing the items he/she creates and capable of using other safe APIs;
|
||||
* *Catalogue-Admin*: a user with such a role is capable of administrating many aspects of the catalogue;
|
||||
* *Catalogue-Manager*: a user with such a role is capable of using all the APIs exposed by the service except moderation item APIs (i.e. approve, reject).
|
||||
Catalogue-Member:
|
||||
a user with such a role is mainly capable of listing and reading items;
|
||||
|
||||
Catalogue-Editor:
|
||||
a user with such a role is capable of managing the items he/she creates and capable of using other safe APIs;
|
||||
|
||||
Catalogue-Admin:
|
||||
a user with such a role is capable of administrating many aspects of the catalogue;
|
||||
|
||||
Catalogue-Manager:
|
||||
a user with such a role is capable of using all the APIs exposed by the service except moderation item APIs (i.e. approve, reject).
|
||||
|
||||
|
||||
Another role that is not in the role hierarchy:
|
||||
|
||||
* *Catalogue-Moderator*: a user with such a role is capable of invoking the item moderation APIs.
|
||||
Catalogue-Moderator:
|
||||
a user with such a role is capable of invoking the item moderation APIs.
|
||||
|
||||
|
||||
.. TIP::
|
||||
Please note that not all catalogs are moderated.
|
||||
Please note that not all catalogues are moderated.
|
||||
|
||||
|
||||
Moderated Catalogues
|
||||
==================
|
||||
|
||||
Any catalogues can be declared as moderated.
|
||||
In such a case any submitted items must be approved by a Catalogue-Moderator.
|
||||
|
||||
This is the workflow of a item in moderated Catalogue.
|
||||
|
||||
|
||||
|
||||
|
||||
Java Client
|
||||
==================
|
||||
|
|
|
@ -119,13 +119,13 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
|
|||
* </dd>
|
||||
* <dl>
|
||||
*
|
||||
* <h4>Moderated Catalog filtering options</h4>
|
||||
* <h4>Moderated Catalogue filtering options</h4>
|
||||
* <dl>
|
||||
* <dt>status (enum)</dt>
|
||||
* <dd>
|
||||
* <em>Optional</em>.<em>Default:null</em>.<br/>
|
||||
*
|
||||
* <span style="font-weight:bold;">It has sense only for moderated catalogs</span>.<br/>
|
||||
* <span style="font-weight:bold;">It has sense only for moderated catalogues</span>.<br/>
|
||||
* When no value is provided, it returns both the items which have been published before the activation of the moderation,
|
||||
* as weel as the items explicitly <code>approved</code> after the moderation activation.
|
||||
*
|
||||
|
|
Loading…
Reference in New Issue