org.graylog2.shared.rest.resources.documentation

Class DocumentationResource

java.lang.Object

org.graylog2.shared.rest.resources.RestResource

org.graylog2.shared.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

configuration, userService

Constructor Summary

Constructors

Constructor and Description
DocumentationResource(HttpConfiguration httpConfiguration, com.fasterxml.jackson.databind.ObjectMapper objectMapper, DocumentationRestResourceClasses documentationRestResourceClasses)

Method Summary

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

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

checkAnyPermission, checkPermission, checkPermission, getCurrentUser, getIndexSet, getSubject, getUriBuilderToSelf, isAnyPermitted, isAnyPermitted, isPermitted, isPermitted, 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(HttpConfiguration httpConfiguration,
                                     com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                     DocumentationRestResourceClasses documentationRestResourceClasses)

Method Detail

overview

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

globalOverview

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

route

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