Expand description
Type definitions of the input and output data structures of the SDK.
Structs§
- Authorization
Decisions - 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.
- Deny
Some Builder - To be used when denying some of the elements. By default everything is granted.
- Enum
Directive Site - A directive site for enums
- 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.
- Error
Response - A response containing a status code and multiple errors.
- Field
Definition Directive - A field definition directive with its site information
- Field
Definition Directive Site - A directive site for field definitions
- Field
Input - Response data, if any, for an item to resolve.
- Field
Inputs - List of resolver inputs, each containing the relevant response data associated with the resolved item.
- Field
Inputs Iterator - Iterator over the resolver inputs.
- Field
Output - Output for a resolver
- Field
Output Builder - Accumulator for setting the output individually for each
FieldInput. - Interface
Directive Site - A directive site for interfaces
- Object
Directive Site - A directive site for object types
- Query
Element - An element of the query on which a directive was applied.
- Query
Element Id - An identifier for a query element. Only relevant for response authorization as data provided in
authorize_querywon’t be re-sent inauthorize_response. So this ID allows finding the relevant data in the custom state. - Query
Elements - A list of elements present in the query on which one of the extension’s directive was applied on their definition.
- Query
Elements Iterator - Iterator over the elements of the query on which a directive was applied.
- Response
Element - An element of the query on which a directive was applied.
- Response
Elements - A list of elements present in the query on which one of the extension’s directive was applied on their definition.
- Response
Elements Iterator - Iterator over the elements of the query on which a directive was applied.
- Response
Item - Represents a single item, object or field, that is subject to an authorization rule with the data requested by the directive.
- Scalar
Directive Site - A directive site for scalars
- Schema
Directive - The directive and its arguments which define the extension in the GraphQL SDK.
- Status
Code - An HTTP status code (
status-codein RFC 9110 et al.). - Subscription
Output - List of items to be returned by a subscriptions. If there are no items to return, use the default value.
- Subscription
Output Builder - Accumulator for setting the output individually for each
ResolverInput. - Token
- Token produced by an authentication extension.
- Union
Directive Site - A directive site for union types
Enums§
- Directive
Site - The site where a directive is applied in the GraphQL schema.
Traits§
- Deserialize
- A data structure that can be deserialized from any data format supported by Serde.
- Query
Element OrResponse Item - Either a
QueryElementor aResponseItem.