From cf4da9015e0f7e2770fad2e365253a009b7dcb3f Mon Sep 17 00:00:00 2001 From: Patrick Huang Date: Tue, 24 Jun 2014 13:10:39 +1000 Subject: [PATCH] rhbz1110627 - add REST endpoint for project config --- .../client/IProjectIterationResource.java | 6 ++++++ .../service/ProjectIterationResource.java | 20 +++++++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/zanata-common-api/src/main/java/org/zanata/rest/client/IProjectIterationResource.java b/zanata-common-api/src/main/java/org/zanata/rest/client/IProjectIterationResource.java index 813d99d..2d79afb 100644 --- a/zanata-common-api/src/main/java/org/zanata/rest/client/IProjectIterationResource.java +++ b/zanata-common-api/src/main/java/org/zanata/rest/client/IProjectIterationResource.java @@ -31,4 +31,10 @@ public interface IProjectIterationResource extends ProjectIterationResource { MediaTypes.APPLICATION_ZANATA_PROJECT_ITERATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) public ClientResponse put(ProjectIteration project); + + @GET + @Path("/config") + @Produces({ MediaType.APPLICATION_XML }) + @Override + ClientResponse sampleConfiguration(); } diff --git a/zanata-common-api/src/main/java/org/zanata/rest/service/ProjectIterationResource.java b/zanata-common-api/src/main/java/org/zanata/rest/service/ProjectIterationResource.java index a7a710c..bb35d2a 100644 --- a/zanata-common-api/src/main/java/org/zanata/rest/service/ProjectIterationResource.java +++ b/zanata-common-api/src/main/java/org/zanata/rest/service/ProjectIterationResource.java @@ -25,6 +25,7 @@ import javax.ws.rs.GET; import javax.ws.rs.HEAD; import javax.ws.rs.PUT; +import javax.ws.rs.Path; import javax.ws.rs.Produces; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; @@ -109,4 +110,23 @@ public interface ProjectIterationResource { MediaTypes.APPLICATION_ZANATA_PROJECT_ITERATION_JSON, MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON }) public Response put(ProjectIteration project); + + /** + * Get a project iteration's sample general configuration file(zanata.xml). + * Note: this will only be a sample configuration which does not contain any + * customization done on the client side, such as, locale mapping and/or + * command hooks. + * + * @return The following response status codes will be returned from this + * operation:
+ * OK(200) - Contains the Project iteration config xml.
+ * NOT FOUND(404) - response, if a Project iteration could not be + * found for the given parameters.
+ * INTERNAL SERVER ERROR(500) - If there is an unexpected error in + * the server while performing this operation. + */ + @GET + @Path("/config") + @Produces({ MediaType.APPLICATION_XML }) + public Response sampleConfiguration(); }