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

Updating documentation

This commit is contained in:
Luca Frosini 2022-09-20 17:59:14 +02:00
parent 562ad114c3
commit 1756db032f
2 changed files with 37 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/index.rst
View File

@ -204,7 +204,7 @@ 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 can use all the APIs exposed by the service except item moderation APIs (i.e. approve, reject).
A user with such a role can use all the APIs exposed by the service except item moderation APIs (e.g. approve, reject, ...).
Another role that is not in the role hierarchy:
@ -286,13 +286,13 @@ The following table summarize the allowed/forbidden operations depending on: the
+ + +----------------------+--------------------------+------------------------------------------+-------------------+
| | | Catalogue Moderator | Catalogue Admin/Manager | Catalogue Editor | Catalogue Member |
+=====================================+=============+======================+==========================+==========================================+===================+
| List | | Yes all states | Yes all states | Yes only approved - All states if owner | Yes only approved |
| List | Yes all states | Yes all states | Yes only approved - All states if Author | Yes only approved |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Count | | Yes all states | Yes all states | Yes only approved - All states if owner | Yes only approved |
| Count | Yes all states | Yes all states | Yes only approved - All states if Author | Yes only approved |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Create | | 403 Forbidden | Yes -> Pending | Yes -> Pending | 403 Forbidden |
| Create | 403 Forbidden | Yes -> Pending | Yes -> Pending | 403 Forbidden |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Read | | Yes alla states | Yes all states | Yes only approved - All states if owner | Yes only approved |
| Read | Yes all states | Yes all states | Yes only approved - All states if Author | Yes only approved |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Update | Pending | Yes -> Pending | 403 Forbidden | Yes if Author -> Pending | 403 Forbidden |
+ +-------------+----------------------+--------------------------+------------------------------------------+-------------------+
@ -306,13 +306,41 @@ The following table summarize the allowed/forbidden operations depending on: the
+ +-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| | Approved | 403 Forbidden | Yes | Yes if Author | 403 Forbidden |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Approve a pending item | | Yes | 403 Forbidden | 403 Forbidden | 403 Forbidden |
| Approve a pending item | Yes | 403 Forbidden | 403 Forbidden | 403 Forbidden |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Reject a pending item | | Yes | 403 Forbidden | 403 Forbidden | 403 Forbidden |
| Reject a pending item | Yes | 403 Forbidden | 403 Forbidden | 403 Forbidden |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
| Message about an item in any state | | Yes | 403 Forbidden | Yes | 403 Forbidden |
| Message about an item | Yes | Yes if Author | Yes if Author | 403 Forbidden |
+-------------------------------------+-------------+----------------------+--------------------------+------------------------------------------+-------------------+
The Moderation process has associated notification to authors and Catalogue-Moderators.
Please note that the user who has acted is not self-notified, e.g.
approve operation made by a Catalogue-Moderator notifies the item author and the other Catalogue-Moderators of the VRE.
The following table summarises the addressee of the notification for any action.
.. table::
+------------+-------------------------+-----------------+
| Operation | Notified user/role |
+ +-------------------------+-----------------+
| | Catalogue-Moderators | Author |
+============+===========================================+
| Create | Yes | No |
+------------+-------------------------------------------+
| Update | Yes | Yes |
+------------+-------------------------------------------+
| Approve | Yes + Social Post if enabled for the VRE |
+------------+-------------------------------------------+
| Reject | Yes | Yes |
+------------+-------------------------------------------+
| Message | Yes | Yes |
+------------+-------------------------------------------+
Java Client
==================

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

@ -137,7 +137,7 @@ public class Item extends REST<CKANPackage> implements org.gcube.gcat.api.interf
* </ul>
*
* <p>
* Please note that only Catalogue-Moderators can filter items by status.<br />
* Please note that only Catalogue-Moderators can filter all items by status.<br />
* Other users using this query parameter will get only its own items with such a status in the results.
* </p>
* </dd>