Module io.helidon.openapi
Package io.helidon.openapi.internal

Class OpenAPIConfigImpl.Builder

  • All Implemented Interfaces:
    io.helidon.common.Builder<io.smallrye.openapi.api.OpenApiConfig>, Supplier<io.smallrye.openapi.api.OpenApiConfig>
    Enclosing class:
    OpenAPIConfigImpl
    public static final class OpenAPIConfigImpl.Builder
extends Object
implements io.helidon.common.Builder<io.smallrye.openapi.api.OpenApiConfig>
    Fluent builder for OpenAPIConfigImpl.

    The caller can set values individually by invoking the method corresponding to each value, or by passing a Config object with keys as follows:

    Configuration for Setting OpenAPIConfig
    Key
    "model.reader"
    "filter"
    "servers"
    "servers.path"
    "servers.operation"

    • Method Detail

      • build

        public io.smallrye.openapi.api.OpenApiConfig build()
        Specified by:
        build in interface io.helidon.common.Builder<io.smallrye.openapi.api.OpenApiConfig>

      • config

        public OpenAPIConfigImpl.Builder config​(Config config)
        Sets the builder's attributes according to the corresponding entries (if present) in the specified openapi Config object.
        Parameters:
        config - openapi Config object to process
        Returns:
        updated builder

      • modelReader

        public OpenAPIConfigImpl.Builder modelReader​(String modelReader)
        Sets the developer-provided OpenAPI model reader.
        Parameters:
        modelReader - model reader
        Returns:
        updated builder

      • filter

        public OpenAPIConfigImpl.Builder filter​(String filter)
        Sets the developer-provided OpenAPI filter.
        Parameters:
        filter - filter object
        Returns:
        updated builder

      • operationServers

        public OpenAPIConfigImpl.Builder operationServers​(String operationID,
                                                  String operationServers)
        Sets operation servers.
        Parameters:
        operationID - operation ID
        operationServers - comma-separated list of servers for the given operation
        Returns:
        updated builder

      • addOperationServer

        public OpenAPIConfigImpl.Builder addOperationServer​(String operationID,
                                                    String operationServer)
        Adds an operation server.
        Parameters:
        operationID - operation ID for the server being added
        operationServer - the server being added
        Returns:
        updated builder

      • pathServers

        public OpenAPIConfigImpl.Builder pathServers​(String path,
                                             String pathServers)
        Sets path servers.
        Parameters:
        path - path for the servers being set
        pathServers - comma-list of servers for the given path
        Returns:
        updated builder

      • addPathServer

        public OpenAPIConfigImpl.Builder addPathServer​(String path,
                                               String pathServer)
        Adds a path server.
        Parameters:
        path - path for the server being added
        pathServer - the server being added
        Returns:
        updated builder

      • servers

        public OpenAPIConfigImpl.Builder servers​(String servers)
        Sets servers.
        Parameters:
        servers - comma-list of servers
        Returns:
        updated builder

      • scanDisable

        public OpenAPIConfigImpl.Builder scanDisable​(boolean value)
        Sets whether annotation scanning should be disabled.
        Parameters:
        value - new setting for annotation scanning disabled flag
        Returns:
        updated builder

      • schemaReferencesEnable

        public OpenAPIConfigImpl.Builder schemaReferencesEnable​(Boolean value)
        Sets whether schema references are enabled.
        Parameters:
        value - new setting for schema references enabled
        Returns:
        updated builder

      • customSchemaRegistryClass

        public OpenAPIConfigImpl.Builder customSchemaRegistryClass​(String className)
        Sets the custom schema registry class.
        Parameters:
        className - class to be assigned
        Returns:
        updated builder

      • applicationPathDisable

        public OpenAPIConfigImpl.Builder applicationPathDisable​(Boolean value)
        Sets whether the app path search should be disabled.
        Parameters:
        value - true/false
        Returns:
        updated builder