Package adams.flow.rest
Interface OpenAPISupporter
-
- All Known Implementing Classes:
GenericServer,RatsServer
public interface OpenAPISupporterInterface for classes that support OpenAPI.- Author:
- fracpete (fracpete at waikato dot ac dot nz)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringenableOpenAPITipText()Returns the tip text for this property.booleangetEnableOpenAPI()Returns whether to enable OpenAPI documentation.voidsetEnableOpenAPI(boolean value)Sets whether to enable OpenAPI documentation.
-
-
-
Method Detail
-
setEnableOpenAPI
void setEnableOpenAPI(boolean value)
Sets whether to enable OpenAPI documentation.- Parameters:
value- true if to enable
-
getEnableOpenAPI
boolean getEnableOpenAPI()
Returns whether to enable OpenAPI documentation.- Returns:
- true if to enable
-
enableOpenAPITipText
String enableOpenAPITipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
-