Package 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("/api-docs")
@RequiresAuthentication
public class DocumentationResource
extends RestResource

Field Summary

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

configuration, userService

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	globalOverview()
jakarta.ws.rs.core.Response	overview()
jakarta.ws.rs.core.Response	route(String route, jakarta.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 Details

DocumentationResource

@Inject
public DocumentationResource(HttpConfiguration httpConfiguration,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 DocumentationRestResourceClasses documentationRestResourceClasses,
 Configuration configuration)

Method Details

overview

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

globalOverview

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

route

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