Package io.quarkus.smallrye.graphql.runtime

Class SmallRyeGraphQLConfig

    • Field Detail

      • rootPath

        @ConfigItem(defaultValue="graphql")
public String rootPath
        The rootPath under which queries will be served. Default to graphql By default, this value will be resolved as a path relative to `${quarkus.http.root-path}`.

      • federationEnabled

        @ConfigItem(name="federation.enabled")
public Optional<Boolean> federationEnabled
        Enable Apollo Federation. If this value is unspecified, then federation will be enabled automatically if any GraphQL Federation annotations are detected in the application.

      • metricsEnabled

        @ConfigItem(name="metrics.enabled")
public Optional<Boolean> metricsEnabled
        Enable metrics. By default, this is false. If set to true, a metrics extension is required.

      • tracingEnabled

        @ConfigItem(name="tracing.enabled")
public Optional<Boolean> tracingEnabled
        Enable tracing. By default, this will be enabled if the tracing extension is added.

      • eventsEnabled

        @ConfigItem(name="events.enabled",
            defaultValue="false")
public boolean eventsEnabled
        Enable eventing. Allow you to receive events on bootstrap and execution.

      • nonBlockingEnabled

        @ConfigItem(name="nonblocking.enabled")
public Optional<Boolean> nonBlockingEnabled
        Enable non-blocking support. Default is true.

      • httpPostQueryParametersEnabled

        @ConfigItem(name="http.post.queryparameters.enabled")
public Optional<Boolean> httpPostQueryParametersEnabled
        Enable Query parameter on POST Requests. Allow POST request to override or supply values in a query parameter.

      • autoNameStrategy

        @ConfigItem(defaultValue="Default")
public io.smallrye.graphql.schema.helper.TypeAutoNameStrategy autoNameStrategy
        Change the type naming strategy.

      • errorExtensionFields

        @ConfigItem
public Optional<List<String>> errorExtensionFields
        List of extension fields that should be included in the error response. By default, none will be included. Examples of valid values include [exception,classification,code,description,validationErrorType,queryPath]

      • showRuntimeExceptionMessage

        @ConfigItem
public Optional<List<String>> showRuntimeExceptionMessage
        List of Runtime Exceptions class names that should show the error message. By default, Runtime Exception messages will be hidden and a generic `Server Error` message will be returned.

      • hideCheckedExceptionMessage

        @ConfigItem
public Optional<List<String>> hideCheckedExceptionMessage
        List of Checked Exceptions class names that should hide the error message. By default, Checked Exception messages will show the exception message.

      • defaultErrorMessage

        @ConfigItem
public Optional<String> defaultErrorMessage
        The default error message that will be used for hidden exception messages. Defaults to "Server Error"

      • printDataFetcherException

        @ConfigItem
public Optional<Boolean> printDataFetcherException
        Print the data fetcher exception to the log file. Default `true` in dev and test mode, default `false` in prod.

      • schemaAvailable

        @ConfigItem(defaultValue="true")
public boolean schemaAvailable
        Make the schema available over HTTP.

      • schemaIncludeScalars

        @ConfigItem(defaultValue="false")
public boolean schemaIncludeScalars
        Include the Scalar definitions in the schema.

      • schemaIncludeSchemaDefinition

        @ConfigItem(defaultValue="false")
public boolean schemaIncludeSchemaDefinition
        Include the schema internal definition in the schema.

      • schemaIncludeDirectives

        @ConfigItem(defaultValue="false")
public boolean schemaIncludeDirectives
        Include Directives in the schema.

      • schemaIncludeIntrospectionTypes

        @ConfigItem(defaultValue="false")
public boolean schemaIncludeIntrospectionTypes
        Include Introspection Types in the schema.

      • logPayload

        @ConfigItem(defaultValue="off")
public io.smallrye.graphql.spi.config.LogPayloadOption logPayload
        Log the payload (and optionally variables) to System out.

      • websocketSubprotocols

        @ConfigItem
public Optional<List<String>> websocketSubprotocols
        Subprotocols that should be supported by the server for graphql-over-websocket use cases. Allowed subprotocols are "graphql-ws" and "graphql-transport-ws". By default, both are enabled.

      • parserCaptureIgnoredChars

        @ConfigItem
public Optional<Boolean> parserCaptureIgnoredChars
        Set to true if ignored chars should be captured as AST nodes. Default to false

      • parserCaptureLineComments

        @ConfigItem
public Optional<Boolean> parserCaptureLineComments
        Set to true if `graphql.language.Comment`s should be captured as AST nodes

      • parserCaptureSourceLocation

        @ConfigItem
public Optional<Boolean> parserCaptureSourceLocation
        Set to true true if `graphql.language.SourceLocation`s should be captured as AST nodes. Default to true

      • parserMaxTokens

        @ConfigItem
public Optional<Integer> parserMaxTokens
        The maximum number of raw tokens the parser will accept, after which an exception will be thrown. Default to 15000

      • parserMaxWhitespaceTokens

        @ConfigItem
public Optional<Integer> parserMaxWhitespaceTokens
        The maximum number of raw whitespace tokens the parser will accept, after which an exception will be thrown. Default to 200000

      • instrumentationQueryComplexity

        @ConfigItem
public Optional<Integer> instrumentationQueryComplexity
        Abort a query if the total number of data fields queried exceeds the defined limit. Default to no limit

      • instrumentationQueryDepth

        @ConfigItem
public Optional<Integer> instrumentationQueryDepth
        Abort a query if the total depth of the query exceeds the defined limit. Default to no limit

    • Constructor Detail

      • SmallRyeGraphQLConfig

        public SmallRyeGraphQLConfig()