com.holonplatform.jaxrs.swagger.annotations

Annotation Type ApiContextId

@Target(value={TYPE,PACKAGE})
 @Retention(value=RUNTIME)
 @Documented
public @interface ApiContextId

Annotation which can be used on API definition resource classes to declare the API context id to which the API definition resource is bound.

When an API listing endpoint is configured and bound to an API context id, it will include only the API definitions which corresponds to the API resource classes with a consistent context id value(), if the ApiContextId is present on the API resource class.

Since:

5.2.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Get the API context id.

Element Detail

value

public abstract String value

Get the API context id.

Returns:

the API context id