water.api

Interface RestApiExtension

All Known Implementing Classes:

AbstractRegister, RegisterResourceRoots, RegisterV3Api, RegisterV4Api

public interface RestApiExtension

REST API registration endpoint. The interface should be overriden by clients which would like to provide additional REST API endpoints. The registration is divided into two parts: - register Handlers to expose a new REST API endpoint (e.g., /3/ModelBuilder/XGBoost/) - register Schemas to provide a new definition of REST API input/output

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Provide name of the REST API extension.
void	register(java.lang.String relativeResourcePath) Deprecated. use registerEndPoints(RestApiContext)
void	registerEndPoints(RestApiContext context)
void	registerSchemas(RestApiContext context)

Method Detail

register

@Deprecated
void register(java.lang.String relativeResourcePath)

Deprecated. use registerEndPoints(RestApiContext)

TODO: would be better to pass Jetty object to register `jetty.register(new ApiHandler())

Parameters:

relativeResourcePath -

registerEndPoints

void registerEndPoints(RestApiContext context)

Parameters:

context -

registerSchemas

void registerSchemas(RestApiContext context)

Parameters:

context -

getName

java.lang.String getName()

Provide name of the REST API extension.