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

improving documentation

This commit is contained in:
Luca Frosini 2022-09-28 11:48:23 +02:00
parent 151783e813
commit 7e0c035647
1 changed files with 28 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/main/java/org/gcube/gcat/rest/Configuration.java
View File

@ -98,10 +98,12 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
/**
* This API allows to create the catalogue configuration for the
* context of the request (i.e. the context where the token has been generated)
* using the json provided as request body.
* Only a <a href="../docs/index.html#roles">Catalogue-Manager</a> can invoke this API.
* using the json provided as request body.<br/>
*
* Only a <a href="../docs/index.html#roles">Catalogue-Manager</a> can invoke this API.<br/>
*
* The configuration will be persisted in the infrastructure
* Information System (IS) in the context of the request.
* Information System (IS) in the context of the request.<br/>
*
* Let consider the following example:
*
@ -225,16 +227,16 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
/**
* This API allows to read the catalogue configuration for the
* current context (i.e. the context where the token has been generated).
* current context (i.e. the context where the token has been generated).<br/>
*
* Please refers to <a href="#resource_Configuration_create_json_POST">Create Configuration API</a>
* for the list of configuration properties and their meaning.
* for the list of configuration properties and their meaning.<br/>
*
* This API can be invoked by any user with at least
* <a href="../docs/index.html#roles">Catalogue-Editor</a> role.
* <a href="../docs/index.html#roles">Catalogue-Editor</a> role.<br/>
*
* For any non <a href="../docs/index.html#roles">Catalogue-Manager</a> user the configuration
* will contain only a subset of the properties of the configuration. *
* will contain only a subset of the properties of the configuration.
* Here is an example:
*
* <pre>
@ -250,7 +252,8 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
* }
* </pre>
*
* @param context must contains the context of the request
* @param context must contains the context of the request
* (i.e. the context where the token has been generated)
* or the placeholder <code>CURRENT_CONTEXT</code>.<br/>
* Please note that the context must be URL encoded,
* e.g. /gcube/devsec/devVRE -> %2Fgcube%2Fdevsec%2FdevVRE
@ -304,10 +307,12 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
/**
* This API allows to create/update the catalogue configuration for the
* context of the request (i.e. the context where the token has been generated)
* using the json provided as request body.
* Only a <a href="../docs/index.html#roles">Catalogue-Manager</a> can invoke this API.
* using the json provided as request body.<br/>
*
* Only a <a href="../docs/index.html#roles">Catalogue-Manager</a> can invoke this API.<br/>
*
* The configuration will be persisted in the infrastructure
* Information System (IS) in the context of the request.
* Information System (IS) in the context of the request.<br/>
*
* Let consider the following example:
*
@ -395,7 +400,8 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
*
* </dl>
*
* @param context must contains the context of the request
* @param context must contains the context of the request
* (i.e. the context where the token has been generated)
* or the placeholder <code>CURRENT_CONTEXT</code>.<br/>
* Please note that the context must be URL encoded,
* e.g. /gcube/devsec/devVRE -> %2Fgcube%2Fdevsec%2FdevVRE
@ -452,17 +458,16 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
/**
* This API allows to patch the catalogue configuration for the
* context of the request (i.e. the context where the token has been generated)
* using the json provided as request body.
* Only a <a href="../docs/index.html#roles">Catalogue-Manager</a> can invoke this API.
* using the json provided as request body.<br/>
* Only a <a href="../docs/index.html#roles">Catalogue-Manager</a> can invoke this API. <br/>
* The configuration will be persisted in the infrastructure
* Information System (IS) in the context of the request.
*
*
* Information System (IS) in the context of the request.<br/>
*
* Please refers to <a href="#resource_Configuration_create_json_POST">Create Configuration API</a>
* for the list of configuration properties and their meaning.
*
* @param context must contains the context of the request
* @param context must contains the context of the request
* (i.e. the context where the token has been generated)
* or the placeholder <code>CURRENT_CONTEXT</code>.<br/>
* Please note that the context must be URL encoded,
* e.g. /gcube/devsec/devVRE -> %2Fgcube%2Fdevsec%2FdevVRE
@ -537,10 +542,10 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
/**
* It removes from the cache the configuration for the
* context of the request (i.e. the context where the token has been generated).
* context of the request (i.e. the context where the token has been generated).<br/>
*
* This API forces the service to read again from the Information System (IS)
* the catalogue configuration for the context of the request.
* the catalogue configuration for the context of the request.<br/>
*
* If the user specifies the <code>purge</code> query parameter this API
* remove the configuration from the IS. Please note that this implies that
@ -548,6 +553,7 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
*
*
* @param context context must contains the context of the request
* (i.e. the context where the token has been generated)
* or the placeholder <code>CURRENT_CONTEXT</code>.<br/>
* Please note that the context must be URL encoded,
* e.g. /gcube/devsec/devVRE -> %2Fgcube%2Fdevsec%2FdevVRE
@ -595,12 +601,13 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
/**
* It removes remove the configuration from the IS for the
* context of the request (i.e. the context where the token has been generated).
* context of the request (i.e. the context where the token has been generated).<br/>
*
* Please note that this implies that
* the catalogue is no more configured for the context of the request.
*
* @param context context must contains the context of the request
* (i.e. the context where the token has been generated)
* or the placeholder <code>CURRENT_CONTEXT</code>.<br/>
* Please note that the context must be URL encoded,
* e.g. /gcube/devsec/devVRE -> %2Fgcube%2Fdevsec%2FdevVRE