org.zanata.rest.service

Interface LocalesResource

@Path(value="/locales")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface LocalesResource

Author:

Alex Eng aeng@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createLanguage(LocaleDetails localeDetails) Create a new language in Zanata
javax.ws.rs.core.Response	delete(String localeId) Delete a locale in Zanata
javax.ws.rs.core.Response	get(String filter, String fields, int page, int sizePerPage) Retrieves a full list of locales enabled in Zanata.
javax.ws.rs.core.Response	getDetails(String localeId) Retrieve locale details
javax.ws.rs.core.Response	getMembers(String localeId) Retrieve locale member list
javax.ws.rs.core.Response	getNewLocales(String filter, int size) Retrieves a list of locales that is not added yet in the server.
javax.ws.rs.core.Response	getSourceLocales() Returns list of active source locales of all documents for all active projects.
javax.ws.rs.core.Response	getUITranslations() Retrieves a full list of localized locales for server.

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

Method Detail

get

@GET
 @Produces(value="application/json")
javax.ws.rs.core.Response get(@QueryParam(value="filter")
                                                                        String filter,
                                                                        @QueryParam(value="sort")
                                                                        String fields,
                                                                        @DefaultValue(value="1") @QueryParam(value="page")
                                                                        int page,
                                                                        @DefaultValue(value="10") @QueryParam(value="sizePerPage")
                                                                        int sizePerPage)

Retrieves a full list of locales enabled in Zanata.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing a full list of locales.

getDetails

@GET
 @Path(value="/locale/{localeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response getDetails(@PathParam(value="localeId")
                                                                                                                  String localeId)

Retrieve locale details

getMembers

@GET
 @Path(value="/locale/{localeId}/members")
 @Produces(value="application/json")
javax.ws.rs.core.Response getMembers(@PathParam(value="localeId")
                                                                                                                          String localeId)

Retrieve locale member list

getUITranslations

@GET
 @Path(value="/ui")
 @Produces(value="application/json")
javax.ws.rs.core.Response getUITranslations()

Retrieves a full list of localized locales for server.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing a full list of locales.

getSourceLocales

@GET
 @Produces(value="application/json")
 @Path(value="/source")
javax.ws.rs.core.Response getSourceLocales()

Returns list of active source locales of all documents for all active projects. Restricted to admin

Returns:

OK 200 containing the list of SourceLocaleDetails

getNewLocales

@GET
 @Path(value="/new")
 @Produces(value="application/json")
javax.ws.rs.core.Response getNewLocales(@QueryParam(value="filter")
                                                                                                       String filter,
                                                                                                       @QueryParam(value="size") @DefaultValue(value="10")
                                                                                                       int size)

Retrieves a list of locales that is not added yet in the server.

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing a list of locales.

delete

@DELETE
 @Path(value="/locale/{localeId}")
 @Produces(value="application/json")
javax.ws.rs.core.Response delete(@PathParam(value="localeId")
                                                                                                                 String localeId)

Delete a locale in Zanata

Returns:

The following response status codes will be returned from this operation:
OK(200) - Locale is deleted.

createLanguage

@PUT
 @Path(value="/locale")
 @Produces(value="application/json")
javax.ws.rs.core.Response createLanguage(LocaleDetails localeDetails)

Create a new language in Zanata

Returns:

The following response status codes will be returned from this operation:
OK(201) - Locale is added.
OK(200) - Locale is already exist.