caliban.federation

Type members

Classlikes

trait EntityResolver[-R]

A resolver which is used when attempting to materialize types from their "any" representation

A resolver which is used when attempting to materialize types from their "any" representation

Companion
object
Companion
class
Companion
object
object Federation
Companion
class

Inherited classlikes

case
class GQLExtend()
Inherited from
Federation
case
class GQLExternal()
Inherited from
Federation
case
class GQLKey(fields: String)
Inherited from
Federation
case
class GQLProvides(fields: String)
Inherited from
Federation
case
class GQLRequires(fields: String)
Inherited from
Federation
object Key
Inherited from
Federation
object Provides
Inherited from
Federation
object Requires
Inherited from
Federation

Value members

Inherited methods

def federate[R](original: GraphQL[R], resolver: EntityResolver[R], otherResolvers: EntityResolver[R]*): GraphQL[R]

Accepts a GraphQL as well as entity resolvers in order to support more advanced federation use cases. This variant will allow the gateway to query for entities by resolver.

Accepts a GraphQL as well as entity resolvers in order to support more advanced federation use cases. This variant will allow the gateway to query for entities by resolver.

Value Params
original

The original schema

otherResolvers

Additional resolvers to supply

resolver

A type which can resolve a single type by a key which is provided per type using the @key directive

Inherited from
Federation
def federate[R](original: GraphQL[R]): GraphQL[R]

Accepts a GraphQL and returns a GraphQL with the minimum settings to support federation. This variant does not provide any stitching capabilities, it merely makes this schema consumable by a graphql federation gateway.

Accepts a GraphQL and returns a GraphQL with the minimum settings to support federation. This variant does not provide any stitching capabilities, it merely makes this schema consumable by a graphql federation gateway.

Value Params
original

The original schema

Returns

A new schema which has been augmented with federation types

Inherited from
Federation
def federated[R](resolver: EntityResolver[R], others: EntityResolver[R]*): GraphQLAspect[Nothing, R]
Inherited from
Federation

Inherited fields

val Extend: Directive
Inherited from
Federation
val External: Directive
Inherited from
Federation
lazy
val federated: GraphQLAspect[Nothing, Any]
Inherited from
Federation