From 80559da0ac983d3f3bf56895f3567d2d05da5bb7 Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Fri, 12 Apr 2024 09:56:28 +0200 Subject: [PATCH] Fixing doc --- docs/index.rst | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 658fe5d..42ea49c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -161,17 +161,16 @@ The service accepts and returns only JSON objects. Collections ----------- -The following collections are available to any user. -Catalogue-Editor or above can invoke Non-safe methods only. +The safe methods of following collections are available to any user belonging to the VRE (i.e. Catalogue Member). -* `Profile Collection <../api-docs/resource_Profile.html>`_; -* `Trash Collection <../api-docs/resource_Trash.html>`_; +* `Fishery Collection <../api-docs/resource_FisheryRESTAPIs.html>`_. +* `Stock Collection <../api-docs/resource_StockRESTAPIs.html>`_. +* `Traceability Unit Collection <../api-docs//resource_TraceabilityUnitRESTAPIs.html>`_. + +Catalogue-Editors can invoke non-safe methods. The following collections are available for Catalogue-Admins or above only: -* `Group Collection <../api-docs/resource_Group.html>`_; -* `Organization Collection <../api-docs/resource_Organization.html>`_; -* `User Collection <../api-docs/resource_User.html>`_; * `Configuration Collection <../api-docs/resource_Configuration.html>`_. An overview of the available collections is available at `<../api-docs/index.html>`_; @@ -186,23 +185,18 @@ Only the VRE Manager can assign roles to VRE users. The service uses the following hierarchic roles: -**GRSF-Member**: - A user with such a role is mainly capable of listing and reading items; +**Catalogue-Member**: + A user with such a role is mainly capable of listing and reading records; -**GRSF-Editor**: +**Catalogue-Editor**: A user with such a role is capable of managing the records and capable of using other safe APIs; -**GRSF-Admin**: +**Catalogue-Admin**: A user with such a role is capable of administrating many aspects of the catalogue; -**GRSF-Manager**: - A user with such a role can use all the APIs exposed by the service except item moderation APIs (e.g. approve, reject, ...). +**Catalogue-Manager**: + A user with such a role can use all the APIs exposed by the service. - -Another role that is not in the role hierarchy: - -**GRSF-Moderator**: - A user with such a role is capable of invoking the item moderation APIs. **Methods Result** @@ -213,7 +207,15 @@ The service exposes `its methods <../api-docs/index.html>`_ using a standard nam .. code:: javascript - + { + "license_title": "Creative Commons Attribution Share-Alike 4.0", + "maintainer": "GRSF Publisher", + "id": "f47496b9-7602-40b0-a74c-b33d3341c5be", + "author": "GRSF Publisher", + ... + "name": "23fd6734-b7cd-37eb-8b43-03b1495dd7af", + "title": "Pagellus erythrinus - Levant", + } *Inputs are automatically validated before the request is served.*