Package io.quarkus.smallrye.graphql.runtime

Interface SmallRyeGraphQLRuntimeConfig

@ConfigRoot(phase=RUN_TIME) @ConfigMapping(prefix="quarkus.smallrye-graphql") public interface SmallRyeGraphQLRuntimeConfig

  • Method Details

    • enabled

      @WithName("ui.enabled") @WithDefault("true") boolean enabled()
      If GraphQL UI should be enabled. By default, GraphQL UI is enabled if it is included (see always-include).

    • enable

      @WithName("ui.enable") @Deprecated(since="3.26", forRemoval=true) Optional<Boolean> enable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use quarkus.smallrye-graphql.ui.enabled instead
      If GraphQL UI should be enabled. By default, GraphQL UI is enabled if it is included (see always-include).

    • fieldVisibility

      @WithDefault("default") String fieldVisibility()
      Specifies the field visibility for the GraphQL schema. This configuration item allows you to define comma-separated list of patterns (GraphQLType.GraphQLField). These patterns are used to determine which fields should be excluded from the schema. Special value no-introspection will disable introspection fields. For more info see graphql-java documentation

    • excludeNullFieldsInResponses

      Optional<Boolean> excludeNullFieldsInResponses()
      Excludes all the 'null' fields in the GraphQL response's data field, except for the non-successfully resolved fields (errors). Disabled by default.

    • unwrapExceptions

      Optional<List<String>> unwrapExceptions()
      Exceptions that should be unwrapped (class names).

    • showRuntimeExceptionMessage

      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

      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

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

    • errorExtensionFields

      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]

    • httpGetEnabled

      @WithName("http.get.enabled") @WithDefault("false") boolean httpGetEnabled()
      Enable GET Requests. Allow queries via HTTP GET.

    • httpPostQueryParametersEnabled

      @WithName("http.post.queryparameters.enabled") @WithDefault("false") boolean httpPostQueryParametersEnabled()
      Enable Query parameter on POST Requests. Allow POST request to override or supply values in a query parameter.

    • schemaIncludeScalars

      @WithDefault("false") boolean schemaIncludeScalars()
      Include the Scalar definitions in the schema.

    • schemaIncludeSchemaDefinition

      @WithDefault("false") boolean schemaIncludeSchemaDefinition()
      Include the schema internal definition in the schema.

    • schemaIncludeDirectives

      @WithDefault("false") boolean schemaIncludeDirectives()
      Include Directives in the schema.

    • schemaIncludeIntrospectionTypes

      @WithDefault("false") boolean schemaIncludeIntrospectionTypes()
      Include Introspection Types in the schema.

    • logPayload

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

    • parserCaptureIgnoredChars

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

    • parserCaptureLineComments

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

    • parserCaptureSourceLocation

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

    • parserMaxTokens

      OptionalInt parserMaxTokens()
      The maximum number of raw tokens the parser will accept, after which an exception will be thrown. Default to 15000

    • parserMaxWhitespaceTokens

      OptionalInt parserMaxWhitespaceTokens()
      The maximum number of raw whitespace tokens the parser will accept, after which an exception will be thrown. Default to 200000

    • instrumentationQueryComplexity

      OptionalInt instrumentationQueryComplexity()
      Abort a query if the total number of data fields queried exceeds the defined limit. Default to no limit

    • instrumentationQueryDepth

      OptionalInt instrumentationQueryDepth()
      Abort a query if the total depth of the query exceeds the defined limit. Default to no limit