Module types

Type definitions of the input and output data structures of the SDK.

Structs

ArgumentsId

Identifier for arguments in a GraphQL query

AuthorizationDecisions

Authorization decisions for each query elements to be applied by the GraphQL engine.

Cache

A cache implementation for storing data between requests.

Configuration

Configuration data for the extension, from the gateway toml config.

DefinitionId

Identifier for a GraphQL definition within a schema

DenySomeBuilder

To be used when denying some of the elements. By default everything is granted.

Directive

Represents a GraphQL directive applied to a schema element

EnumDefinition

Represents a GraphQL enum type definition

EnumDirectiveSite

A directive site for enums

EnumValue

Represents a single possible value in a GraphQL enum definition

Error

Graphql Error with a message and extensions

ErrorId

Error identifier to allow re-using the same error for multiple elements. In the gateway response, the error will be repeated if necessary during serialization.

ErrorResponse

A response containing a status code and multiple errors.

Field

A field within a GraphQL query

FieldDefinition

Represents a GraphQL field definition within an object or interface

FieldDefinitionDirectiveSite

A directive site for field definitions

GatewayHeaders

HTTP headers for the gateway request.

HttpHeaders

HTTP headers.

InputObjectDefinition

Represents a GraphQL input object type definition

InputValueDefinition

Represents an input value definition in a GraphQL schema

InterfaceDefinition

Represents a GraphQL interface type definition

InterfaceDirectiveSite

A directive site for interfaces

ObjectDefinition

GraphQL object type definition

ObjectDirectiveSite

A directive site for object types

QueryElement

An element of the query on which a directive was applied.

QueryElementId

An identifier for a query element. Only relevant for response authorization as data provided in authorize_query won’t be re-sent in authorize_response. So this ID allows finding the relevant data in the custom state.

QueryElements

A list of elements present in the query on which one of the extension’s directive was applied on their definition.

QueryElementsIterator

Iterator over the elements of the query on which a directive was applied.

ResolvedField

Represents a resolved field in the context of a subgraph and its parent type

Response

Represents a response from the Grafbase SDK, which can contain data or errors.

ResponseElement

An element of the query on which a directive was applied.

ResponseElements

A list of elements present in the query on which one of the extension’s directive was applied on their definition.

ResponseElementsIterator

Iterator over the elements of the query on which a directive was applied.

ResponseItem

Represents a single item, object or field, that is subject to an authorization rule with the data requested by the directive.

ScalarDefinition

GraphQL scalar type definition

ScalarDirectiveSite

A directive site for scalars

SelectionSet

Represents a selection set in a GraphQL query

SubgraphHeaders

HTTP headers for the subgraph request.

SubgraphSchema

GraphQL schema

Token

Token produced by an authentication extension.

Type

Represents a GraphQL type with its wrapping information

UnionDefinition

Represents a GraphQL union type definition

UnionDirectiveSite

A directive site for union types

Variables

All argument values for a given selection set, to be used with Field.

Enums

Data

Data serialized in either JSON or CBOR

DirectiveSite

The site where a directive is applied in the GraphQL schema.

EntityDefinition

Represents a GraphQL entity definition, which can be either an object or an interface It does not imply that this is a federated entity with a @key directive.

SubscriptionItem

Represents one or multiple items from a subscription.

TypeDefinition

Enum representing the different types of GraphQL definitions

WrappingType

Represents the different ways a GraphQL type can be wrapped