Interface OpenAPISupporter

  • All Known Implementing Classes:
    GenericServer, RatsServer

    public interface OpenAPISupporter
    Interface for classes that support OpenAPI.
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    • 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.