From 53af6be0b97fbed3692617459a8fb3ec43d10b24 Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Fri, 16 Sep 2022 16:35:17 +0200 Subject: [PATCH] Improving docs --- docs/index.rst | 33 +++++++++++++++++---- src/main/java/org/gcube/gcat/rest/Item.java | 4 +-- 2 files changed, 29 insertions(+), 8 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 3058778..4a8d829 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 ================== diff --git a/src/main/java/org/gcube/gcat/rest/Item.java b/src/main/java/org/gcube/gcat/rest/Item.java index 9cecb88..0a446cd 100644 --- a/src/main/java/org/gcube/gcat/rest/Item.java +++ b/src/main/java/org/gcube/gcat/rest/Item.java @@ -119,13 +119,13 @@ public class Item extends REST implements org.gcube.gcat.api.interf * *
* - *

Moderated Catalog filtering options

+ *

Moderated Catalogue filtering options

*
*
status (enum)
*
* Optional.Default:null.
* - * It has sense only for moderated catalogs.
+ * It has sense only for moderated catalogues.
* 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 approved after the moderation activation. *