Package org.talend.sdk.component.server.api

Interface DocumentationResource

@Path("documentation")
public interface DocumentationResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	DocumentationResource.DocumentationSegment

Method Summary

Modifier and Type	Method	Description
DocumentationContent	getDocumentation(String id, String language, DocumentationResource.DocumentationSegment segment)

Method Details

getDocumentation

@GET
@Path("component/{id}")
@Produces("application/json")
DocumentationContent getDocumentation(@PathParam("id")
 String id,
 @QueryParam("language") @DefaultValue("en")
 String language,
 @QueryParam("segment") @DefaultValue("ALL")
 DocumentationResource.DocumentationSegment segment)