The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

Interface: MergedRootFieldConfig

types/src.YamlConfig.MergedRootFieldConfig

Table of contents#

Properties#

Properties#

additionalArgs#

Optional additionalArgs: string

Specifies a string of additional keys and values to apply to other arguments, formatted as """ arg1: "value", arg2: "value" """.

Defined in#

packages/types/src/config.ts:1402


argsExpr#

Optional argsExpr: string

Advanced use only; This argument specifies a string expression that allows more customization of the input arguments. Rules for evaluation of this argument are as follows:

  • basic object parsing of the input key: "arg1: $key.arg1, arg2: $key.arg2"
  • any expression enclosed by double brackets will be evaluated once for each of the requested keys, and then sent as a list: "input: { keys: [[$key]] }"
  • selections from the key can be referenced by using the $ sign and dot notation: "upcs: [[$key.upc]]", so that $key.upc refers to the upc field of the key.

Defined in#

packages/types/src/config.ts:1413


key#

Optional key: string[]

Advanced use only; Allows building a custom key just for the argument from the selectionSet included by the @key directive.

Defined in#

packages/types/src/config.ts:1406


keyArg#

Optional keyArg: string

Specifies which field argument receives the merge key. This may be omitted for fields with only one argument where the recipient can be inferred.

Defined in#

packages/types/src/config.ts:1397


keyField#

Optional keyField: string

Specifies the name of a field to pick off origin objects as the key value. When omitted, a @key directive must be included on the return type's definition to be built into an object key. https://www.graphql-tools.com/docs/stitch-directives-sdl#object-keys

Defined in#

packages/types/src/config.ts:1393


queryFieldName#

queryFieldName: string

Defined in#

packages/types/src/config.ts:1388