org.graylog2.rest.resources.documentation

Class DocumentationResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.rest.resources.documentation.DocumentationResource

@Path(value="/api-docs")
public class DocumentationResource
extends RestResource

Field Summary

Fields inherited from class org.graylog2.shared.rest.resources.RestResource

objectMapper, serverStatus, userService

Constructor Summary

Constructors

Constructor and Description
DocumentationResource(Configuration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	overview()
javax.ws.rs.core.Response	route(String route)

Methods inherited from class org.graylog2.shared.rest.resources.RestResource

bytesToValueMap, checkPermission, checkPermission, getCurrentUser, getSubject, guessContentType, isPermitted, isPermitted, page, restrictToMaster, setPrettyPrint

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentationResource

@Inject
public DocumentationResource(Configuration configuration)

Method Detail

overview

@GET
@Timed
@Produces(value="application/json")
public javax.ws.rs.core.Response overview()

route

@GET
@Timed
@Produces(value="application/json")
@Path(value="/{route: .+}")
public javax.ws.rs.core.Response route(@PathParam(value="route")
                                                      String route)