GraphQL

microgateway.airlock.com/v1alpha1

GraphQL contains the configuration for the GraphQL specification.

​
apiVersion: microgateway.airlock.com/v1alpha1
kind: GraphQL
metadata:
  name: graphql-example
spec:
  settings:
    threatHandlingMode: Block
    allowMutations: true
    allowIntrospection: false
    schema:
      source:
        configMapRef:
          name: graphql-schema
apiVersion: microgateway.airlock.com/v1alpha1
kind: GraphQL
metadata:
  name: default
spec: 
  settings: 
    threatHandlingMode: Block
    allowMutations: true
    allowIntrospection: true

GraphQL

Field Type Description Required Default Allowed Values
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata yes
spec object Specification of the desired GraphQL specification. no

GraphQL.spec

Field Type Description Required Default Allowed Values
settings object Settings defines the settings to configure GraphQL. no

GraphQL.spec.settings

Field Type Description Required Default Allowed Values
allowIntrospection bool AllowIntrospection specifies if the introspection system is exposed. no true true, false
allowMutations bool AllowMutations specifies if mutations are allowed. no true true, false
schema object Specifies the GraphQL schema. no
threatHandlingMode enum ThreatHandlingMode specifies how threats should be handled. no Block Block, LogOnly

GraphQL.spec.settings.schema

Field Type Description Required Default Allowed Values
source object Source specifies the GraphQL schema to be enforced. yes configMapRef{}

GraphQL.spec.settings.schema.source

Field Type Description Required Default Allowed Values
configMapRef object ConfigMapRef references the configmap by its name containing the well-known key ‘schema.graphql’. no

GraphQL.spec.settings.schema.source.configMapRef

Field Type Description Required Default Allowed Values
name string Name of the resource yes