org.zanata.rest.service

Interface GlossaryResource

@Produces(value={"application/xml","application/json","application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json"})
 @Consumes(value={"application/xml","application/json","application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json"})
public interface GlossaryResource

Author:

Alex Eng aeng@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_PAGE_SIZE Maximum result for per page.
static String	SERVICE_PATH

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteAllEntries() Delete all glossary terms.
javax.ws.rs.core.Response	deleteEntry(Long id) Delete glossary which given id.
javax.ws.rs.core.Response	getEntries(LocaleId srcLocale, LocaleId transLocale, int page, int sizePerPage, String filter, String fields) Returns Glossary entries for the given source and translation locale with paging
javax.ws.rs.core.Response	getInfo() Return source locales available for all glossary entries
javax.ws.rs.core.Response	post(List<GlossaryEntry> glossaryEntries) Create or update glossary entry
javax.ws.rs.core.Response	upload(GlossaryFileUploadForm form) Upload glossary file (po, cvs)

Field Detail

SERVICE_PATH

static final String SERVICE_PATH

See Also:

Constant Field Values

MAX_PAGE_SIZE

static final int MAX_PAGE_SIZE

Maximum result for per page.

See Also:

Constant Field Values

Method Detail

getInfo

@GET
 @Path(value="/info")
 @Produces(value={"application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json","application/xml","application/json"})
javax.ws.rs.core.Response getInfo()

Return source locales available for all glossary entries

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing all Glossary entries in the system. INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

getEntries

@GET
 @Path(value="/entries")
 @Produces(value={"application/vnd.zanata.glossary+xml","application/vnd.zanata.glossary+json","application/xml","application/json"})
javax.ws.rs.core.Response getEntries(@DefaultValue(value="en-US") @QueryParam(value="srcLocale")
                                                                                                                                                                                                         LocaleId srcLocale,
                                                                                                                                                                                                         @QueryParam(value="transLocale")
                                                                                                                                                                                                         LocaleId transLocale,
                                                                                                                                                                                                         @DefaultValue(value="1") @QueryParam(value="page")
                                                                                                                                                                                                         int page,
                                                                                                                                                                                                         @DefaultValue(value="1000") @QueryParam(value="sizePerPage")
                                                                                                                                                                                                         int sizePerPage,
                                                                                                                                                                                                         @QueryParam(value="filter")
                                                                                                                                                                                                         String filter,
                                                                                                                                                                                                         @QueryParam(value="sort")
                                                                                                                                                                                                         String fields)

Returns Glossary entries for the given source and translation locale with paging

Parameters:

srcLocale - Source locale - Required (default value: en-US).

transLocale - Translation locale

page - Current request page (default value: 1)

sizePerPage - Size of entry per page (default/max value: 1000) MAX_PAGE_SIZE

filter - String filter for source content

fields - Fields to sort. Comma separated. e.g sort=desc,-part_of_speech See GlossarySortField

Returns:

The following response status codes will be returned from this operation:
OK(200) - Response containing all Glossary entries for the given locale. Bad request(400) - If page or sizePerPage is negative value, or sizePerPage is more than 1000. INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

post

@POST
 @Produces(value={"application/xml","application/json"})
 @Consumes(value={"application/xml","application/json"})
 @Path(value="/entries")
javax.ws.rs.core.Response post(List<GlossaryEntry> glossaryEntries)

Create or update glossary entry

Parameters:

glossaryEntries - The glossary entries to create/update

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the glossary entry were successfully created/updated. UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

upload

@Consumes(value="multipart/form-data")
 @Produces(value="application/json")
 @POST
javax.ws.rs.core.Response upload(GlossaryFileUploadForm form)

Upload glossary file (po, cvs)

Parameters:

form - GlossaryFileUploadForm

Returns:

The following response status codes will be returned from this operation:
CREATED(201) - If files successfully uploaded. UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

deleteEntry

@DELETE
 @Produces(value="application/json")
 @Path(value="/entries/{id}")
javax.ws.rs.core.Response deleteEntry(@PathParam(value="id")
                                                                                                                 Long id)

Delete glossary which given id.

Parameters:

id - id for source glossary term

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the glossary entry were successfully deleted. UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.

deleteAllEntries

@DELETE
javax.ws.rs.core.Response deleteAllEntries()

Delete all glossary terms.

Returns:

The following response status codes will be returned from this operation:
OK(200) - If the glossary entries were successfully deleted. UNAUTHORIZED(401) - If the user does not have the proper permissions to perform this operation.
INTERNAL SERVER ERROR(500) - If there is an unexpected error in the server while performing this operation.