From 292ae3f2c28f198feb17f6ffa2d6443d02fc90a1 Mon Sep 17 00:00:00 2001 From: Luca Frosini Date: Tue, 27 Sep 2022 18:15:51 +0200 Subject: [PATCH] Improving documentation --- .../org/gcube/gcat/rest/Configuration.java | 52 +++++++++++++++---- 1 file changed, 43 insertions(+), 9 deletions(-) diff --git a/src/main/java/org/gcube/gcat/rest/Configuration.java b/src/main/java/org/gcube/gcat/rest/Configuration.java index 0159f50..3d76778 100644 --- a/src/main/java/org/gcube/gcat/rest/Configuration.java +++ b/src/main/java/org/gcube/gcat/rest/Configuration.java @@ -98,6 +98,11 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf /** * Creates the catalogue configuration for the current context using the json * provided as request body. + * Only a Catalogue-Manager can invoke this API. + * The configuration will be persisted in the infrastructure + * Information System (IS) in the context of the request + * (i.e. the context where the token has been generated). + * * * Let consider the following example: * @@ -124,34 +129,63 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf * *
*
context (string)
- *
;
+ *
it must contains the same value of requesting context;
* *
defaultOrganization (string)
- *
;
+ *
+ * the default ckan organization where an item is created for + * the context of the request; + *
* *
supportedOrganizations (array of string)
- *
;
+ *
+ * it defines the list of organization where an item can be created. + * All the organizations must be present in the catalogue of the VRE. + * It must contains at least the defaultOrganization value; + *
* *
sysAdminToken (string)
- *
;
+ *
+ * the token can be provided encrypted with the context key as well as plain. + * It any case it is persisted encrypted in IS; + *
* *
ckanURL (string)
- *
;
+ *
+ * the Ckan URL used for the catalogue of the VRE. + *
* *
solrURL (string)
- *
;
+ *
+ * the Solr URL used by the Ckan instance. + * This is normally, but not necessary, the same URL of Ckan plus the path /solr + *
* *
socialPostEnabled (bool)
- *
;
+ *
+ * it indicates if the social posts are enabled in the context of the request. + * The creation of a social post can be requested by a user when he/she creates + * an item; + *
* *
notificationToUsersEnabled (bool)
- *
;
+ *
+ * it indicates if a notification must be created when a social post + * is created. It is ignored if socialPostEnabled=false; + *
* *
moderationEnabled (bool)
- *
;
+ *
+ * it indicates if the catalogue is moderated. + * See Moderated Catalogues + *
* *
ckanDB (object)
*
+ * it contains the url, username and password to contact the db used by the + * Ckan instance used for the catalogue of the VRE. + * The password can be provided encrypted with the context key as well as plain. + * It any case it is persisted encrypted in IS. *
* *