org.onosproject.rest

Interface ApiDocService

@Beta
public interface ApiDocService

Service for registering REST API documentation resources.

Method Summary

Modifier and Type	Method and Description
ApiDocProvider	getDocProvider(java.lang.String key) Returns the specified REST API documentation provider with the specified key.
java.util.Set<ApiDocProvider>	getDocProviders() Returns the set of all registered REST API documentation providers.
void	register(ApiDocProvider provider) Registers the specified REST API documentation provider.
void	unregister(ApiDocProvider provider) Unregisters the specified REST API documentation provider.

Method Detail

register

void register(ApiDocProvider provider)

Registers the specified REST API documentation provider.

Parameters:

provider - REST API documentation provider

unregister

void unregister(ApiDocProvider provider)

Unregisters the specified REST API documentation provider.

Parameters:

provider - REST API documentation provider

getDocProviders

java.util.Set<ApiDocProvider> getDocProviders()

Returns the set of all registered REST API documentation providers.

Returns:

set of registered documentation providers

getDocProvider

ApiDocProvider getDocProvider(java.lang.String key)

Returns the specified REST API documentation provider with the specified key.

Parameters:

key - REST API key

Returns:

documentation provider