diff --git a/enunciate.xml b/enunciate.xml index 4d33794..5313cc5 100644 --- a/enunciate.xml +++ b/enunciate.xml @@ -2,8 +2,10 @@ + + diff --git a/src/main/java/org/gcube/gcat/ResourceInitializer.java b/src/main/java/org/gcube/gcat/ResourceInitializer.java index d3618b9..ffdc273 100644 --- a/src/main/java/org/gcube/gcat/ResourceInitializer.java +++ b/src/main/java/org/gcube/gcat/ResourceInitializer.java @@ -2,7 +2,7 @@ package org.gcube.gcat; import javax.ws.rs.ApplicationPath; -import org.gcube.gcat.rest.Group; +import org.gcube.gcat.rest.administration.Group; import org.glassfish.jersey.server.ResourceConfig; /** diff --git a/src/main/java/org/gcube/gcat/rest/License.java b/src/main/java/org/gcube/gcat/rest/License.java index e82bbe0..4270848 100644 --- a/src/main/java/org/gcube/gcat/rest/License.java +++ b/src/main/java/org/gcube/gcat/rest/License.java @@ -7,12 +7,14 @@ import javax.ws.rs.Produces; import org.gcube.gcat.api.GCatConstants; import org.gcube.gcat.persistence.ckan.CKANLicense; +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * @author Luca Frosini (ISTI - CNR) */ @Path(License.LICENSES) +@ResourceGroup("Item Related APIs") @ResourceLabel("License APIs") public class License extends REST implements org.gcube.gcat.api.interfaces.License { diff --git a/src/main/java/org/gcube/gcat/rest/Namespace.java b/src/main/java/org/gcube/gcat/rest/Namespace.java index 25494e1..283e67c 100644 --- a/src/main/java/org/gcube/gcat/rest/Namespace.java +++ b/src/main/java/org/gcube/gcat/rest/Namespace.java @@ -14,12 +14,14 @@ import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.NamespaceCategory; import org.gcube.gcat.api.GCatConstants; import org.gcube.gcat.profile.MetadataUtility; +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * @author Luca Frosini (ISTI - CNR) */ @Path(Namespace.NAMESPACES) +@ResourceGroup("Item Related APIs") @ResourceLabel("Namespace APIs") public class Namespace extends BaseREST implements org.gcube.gcat.api.interfaces.Namespace { diff --git a/src/main/java/org/gcube/gcat/rest/Profile.java b/src/main/java/org/gcube/gcat/rest/Profile.java index e31c256..eb598ca 100644 --- a/src/main/java/org/gcube/gcat/rest/Profile.java +++ b/src/main/java/org/gcube/gcat/rest/Profile.java @@ -31,12 +31,14 @@ import org.gcube.gcat.api.GCatConstants; import org.gcube.gcat.profile.ISProfile; import org.xml.sax.SAXException; +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * @author Luca Frosini (ISTI - CNR) */ @Path(Profile.PROFILES) +@ResourceGroup("Item Related APIs") @ResourceLabel("Profile APIs") public class Profile extends BaseREST implements org.gcube.gcat.api.interfaces.Profile { diff --git a/src/main/java/org/gcube/gcat/rest/Trash.java b/src/main/java/org/gcube/gcat/rest/Trash.java index 1e8d6ef..c65d14d 100644 --- a/src/main/java/org/gcube/gcat/rest/Trash.java +++ b/src/main/java/org/gcube/gcat/rest/Trash.java @@ -24,8 +24,8 @@ import com.webcohesion.enunciate.metadata.rs.ResourceLabel; * @author Luca Frosini (ISTI - CNR) */ @Path(Trash.TRASH) -@ResourceGroup("Item APIs") -@ResourceLabel("Item's Trash APIs") +@ResourceGroup("Item Related APIs") +@ResourceLabel("Trash APIs") public class Trash extends BaseREST implements org.gcube.gcat.api.interfaces.Trash { diff --git a/src/main/java/org/gcube/gcat/rest/Configuration.java b/src/main/java/org/gcube/gcat/rest/administration/Configuration.java similarity index 99% rename from src/main/java/org/gcube/gcat/rest/Configuration.java rename to src/main/java/org/gcube/gcat/rest/administration/Configuration.java index c300ef6..efc3e4f 100644 --- a/src/main/java/org/gcube/gcat/rest/Configuration.java +++ b/src/main/java/org/gcube/gcat/rest/administration/Configuration.java @@ -1,4 +1,4 @@ -package org.gcube.gcat.rest; +package org.gcube.gcat.rest.administration; import java.util.Iterator; @@ -34,9 +34,11 @@ import org.gcube.gcat.configuration.CatalogueConfigurationFactory; import org.gcube.gcat.configuration.ServiceCatalogueConfiguration; import org.gcube.gcat.persistence.ckan.CKANUser; import org.gcube.gcat.persistence.ckan.CKANUserCache; +import org.gcube.gcat.rest.BaseREST; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; import com.webcohesion.enunciate.metadata.rs.ResponseCode; import com.webcohesion.enunciate.metadata.rs.StatusCodes; @@ -46,6 +48,7 @@ import com.webcohesion.enunciate.metadata.swagger.OperationId; * @author Luca Frosini (ISTI - CNR) */ @Path(Configuration.CONFIGURATIONS) +@ResourceGroup("Administration APIs") @ResourceLabel("Configuration APIs") public class Configuration extends BaseREST implements org.gcube.gcat.api.interfaces.Configuration { diff --git a/src/main/java/org/gcube/gcat/rest/Group.java b/src/main/java/org/gcube/gcat/rest/administration/Group.java similarity index 96% rename from src/main/java/org/gcube/gcat/rest/Group.java rename to src/main/java/org/gcube/gcat/rest/administration/Group.java index 902b323..da355e3 100644 --- a/src/main/java/org/gcube/gcat/rest/Group.java +++ b/src/main/java/org/gcube/gcat/rest/administration/Group.java @@ -1,4 +1,4 @@ -package org.gcube.gcat.rest; +package org.gcube.gcat.rest.administration; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; @@ -20,13 +20,16 @@ import org.gcube.gcat.annotation.PURGE; import org.gcube.gcat.api.GCatConstants; //import org.gcube.gcat.api.roles.Role; import org.gcube.gcat.persistence.ckan.CKANGroup; +import org.gcube.gcat.rest.REST; +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * @author Luca Frosini (ISTI - CNR) */ @Path(Group.GROUPS) +@ResourceGroup("Administration APIs") @ResourceLabel("Group APIs") public class Group extends REST implements org.gcube.gcat.api.interfaces.Group { diff --git a/src/main/java/org/gcube/gcat/rest/Organization.java b/src/main/java/org/gcube/gcat/rest/administration/Organization.java similarity index 94% rename from src/main/java/org/gcube/gcat/rest/Organization.java rename to src/main/java/org/gcube/gcat/rest/administration/Organization.java index e212a81..321a170 100644 --- a/src/main/java/org/gcube/gcat/rest/Organization.java +++ b/src/main/java/org/gcube/gcat/rest/administration/Organization.java @@ -1,4 +1,4 @@ -package org.gcube.gcat.rest; +package org.gcube.gcat.rest.administration; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; @@ -20,11 +20,17 @@ import org.gcube.gcat.annotation.PURGE; import org.gcube.gcat.api.GCatConstants; //import org.gcube.gcat.api.roles.Role; import org.gcube.gcat.persistence.ckan.CKANOrganization; +import org.gcube.gcat.rest.REST; + +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; +import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * @author Luca Frosini (ISTI - CNR) */ @Path(Organization.ORGANIZATIONS) +@ResourceGroup("Administration APIs") +@ResourceLabel("Organization APIs") public class Organization extends REST implements org.gcube.gcat.api.interfaces.Organization { diff --git a/src/main/java/org/gcube/gcat/rest/User.java b/src/main/java/org/gcube/gcat/rest/administration/User.java similarity index 96% rename from src/main/java/org/gcube/gcat/rest/User.java rename to src/main/java/org/gcube/gcat/rest/administration/User.java index 1d10980..ca331e3 100644 --- a/src/main/java/org/gcube/gcat/rest/User.java +++ b/src/main/java/org/gcube/gcat/rest/administration/User.java @@ -1,4 +1,4 @@ -package org.gcube.gcat.rest; +package org.gcube.gcat.rest.administration; import javax.ws.rs.Consumes; import javax.ws.rs.DELETE; @@ -22,13 +22,16 @@ import org.gcube.gcat.api.roles.Role; //import org.gcube.gcat.api.roles.Role; import org.gcube.gcat.persistence.ckan.CKANUser; import org.gcube.gcat.persistence.ckan.CKANUserCache; +import org.gcube.gcat.rest.REST; +import com.webcohesion.enunciate.metadata.rs.ResourceGroup; import com.webcohesion.enunciate.metadata.rs.ResourceLabel; /** * @author Luca Frosini (ISTI - CNR) */ @Path(User.USERS) +@ResourceGroup("Administration APIs") @ResourceLabel("User APIs") public class User extends REST implements org.gcube.gcat.api.interfaces.User { diff --git a/src/main/java/org/gcube/gcat/rest/package-info.java b/src/main/java/org/gcube/gcat/rest/package-info.java new file mode 100644 index 0000000..3df827d --- /dev/null +++ b/src/main/java/org/gcube/gcat/rest/package-info.java @@ -0,0 +1,13 @@ +/** + *

gCube Catalogue (gCat) Service

+ * + *

Welcome to gCube Catalogue Service (aka gCat) API documentation.

+ * + *

+ * To get a complete overview of gCat service take a look at + * wiki page. + *

+ * + * + */ +package org.gcube.gcat.rest; \ No newline at end of file