/
ProjectLocalesResource.java
87 lines (79 loc) · 3.21 KB
/
ProjectLocalesResource.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/*
* Copyright 2014, Red Hat, Inc. and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.zanata.rest.service;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import com.webcohesion.enunciate.metadata.rs.ResourceLabel;
import com.webcohesion.enunciate.metadata.rs.ResponseCode;
import com.webcohesion.enunciate.metadata.rs.StatusCodes;
import org.zanata.rest.MediaTypes;
import org.zanata.rest.dto.LocaleDetails;
import com.webcohesion.enunciate.metadata.rs.TypeHint;
import org.zanata.rest.dto.SourceLocaleDetails;
/**
* REST interface for configured project locales.
* @see {@link ProjectIterationLocalesResource} Version locales
*/
@Path(ProjectLocalesResource.SERVICE_PATH)
@Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
@ResourceLabel("Project locales")
public interface ProjectLocalesResource {
public static final String SERVICE_PATH = ProjectResource.SERVICE_PATH
+ "/locales";
/**
* Returns list of active locales for a single project.
*
* This may be the list of locales inherited from the server.
*
* @return
* OK 200 containing the list of LocaleDetails
* NOT FOUND 404 if the project does not exist
*/
@GET
@TypeHint(LocaleDetails[].class)
@Produces({ MediaTypes.APPLICATION_ZANATA_PROJECT_LOCALES_XML,
MediaTypes.APPLICATION_ZANATA_PROJECT_LOCALES_JSON,
MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
@StatusCodes({
@ResponseCode(code = 200, condition = "Content contains a list of locale details"),
@ResponseCode(code = 404, condition = "The project is not found"),
})
public Response get();
/**
* Returns list of active source locales of all documents for a single project.
*
* @return
* OK 200 containing the list of SourceLocaleDetails
* NOT FOUND 404 if the project does not exist
*/
@GET
@StatusCodes({
@ResponseCode(code = 200, condition = "Content contains a list of source locale details"),
@ResponseCode(code = 404, condition = "The project is not found"),
})
@TypeHint(SourceLocaleDetails[].class)
@Path("/source")
@Produces(MediaType.APPLICATION_JSON)
public Response getSourceLocales();
}