caliban
API
Generated with
caliban/caliban/caliban.schema/Annotations

Annotations

caliban.schema.Annotations
object Annotations extends AnnotationsVersionSpecific

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class GQLDefault(value: String) extends StaticAnnotation

Annotation to specify the default value of an input field

Annotation to specify the default value of an input field

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLDeprecated(reason: String) extends StaticAnnotation

Annotation used to indicate a type or a field is deprecated.

Annotation used to indicate a type or a field is deprecated.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLDescription(value: String) extends StaticAnnotation

Annotation used to provide a description to a field or a type.

Annotation used to provide a description to a field or a type.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLExcluded() extends StaticAnnotation

Annotation used to exclude a field from a type.

Annotation used to exclude a field from a type.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLInputName(name: String) extends StaticAnnotation

Annotation used to customize the name of an input type. This is usually needed to avoid a name clash when a type is used both as an input and an output.

Annotation used to customize the name of an input type. This is usually needed to avoid a name clash when a type is used both as an input and an output.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLInterface(excludedFields: String*) extends StaticAnnotation

Annotation to make a sealed trait an interface instead of a union type or an enum

Annotation to make a sealed trait an interface instead of a union type or an enum

Value parameters

excludedFields

Optionally provide a list of field names that should be excluded from the interface

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLName(value: String) extends StaticAnnotation

Annotation used to provide an alternative name to a field or a type.

Annotation used to provide an alternative name to a field or a type.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLNonNullable() extends StaticAnnotation

Annotation that can be applied to force a field to be derived as non-nullable

Annotation that can be applied to force a field to be derived as non-nullable

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLNullable() extends StaticAnnotation

Annotation that can be applied to force a field to be derived as nullable

Annotation that can be applied to force a field to be derived as nullable

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLOneOfInput() extends StaticAnnotation

Annotation to make a sealed trait as a GraphQL @oneOf input

Annotation to make a sealed trait as a GraphQL @oneOf input

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLUnion() extends StaticAnnotation

Annotation to make a sealed trait a union instead of an enum

Annotation to make a sealed trait a union instead of an enum

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLValueType(isScalar: Boolean = ...) extends StaticAnnotation

Annotation to make a case class redirect to its inner type. The Schema of the inner type will be used, unless isScalar is true in which case a scalar with the name of the parent case class will be created.

Annotation to make a case class redirect to its inner type. The Schema of the inner type will be used, unless isScalar is true in which case a scalar with the name of the parent case class will be created.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all

Inherited classlikes

open class GQLDirective(val directive: Directive) extends StaticAnnotation

Annotation used to provide directives to a schema type

Annotation used to provide directives to a schema type

Attributes

Inherited from:
AnnotationsVersionSpecific
Supertypes
class Annotation
class Object
trait Matchable
class Any
Known subtypes
class GQLCost
object GQLDirective

Attributes

Inherited from:
AnnotationsVersionSpecific
Supertypes
class Object
trait Matchable
class Any
case class GQLField() extends StaticAnnotation

Annotation that can be used on a case class method to mark it as a GraphQL field. The method must be public, a def (does not work on vals / lazy vals) and must not take any arguments.

Annotation that can be used on a case class method to mark it as a GraphQL field. The method must be public, a def (does not work on vals / lazy vals) and must not take any arguments.

'''NOTE''' This annotation is not safe for use with ahead-of-time compilation (e.g., generating a GraalVM native-image executable)

Attributes

Inherited from:
AnnotationsVersionSpecific
Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
case class GQLFieldsFromMethods() extends StaticAnnotation

Annotation that can be used on a case class / case object to have all the public methods on it derived as fields.

Annotation that can be used on a case class / case object to have all the public methods on it derived as fields.

If you wish to exclude a public method from being derived as a field, you can annotate it with GQLExclude.

Attributes

See also

GQLField for a more fine-grained control over which methods are derived as fields

Inherited from:
AnnotationsVersionSpecific
Supertypes
trait Serializable
trait Product
trait Equals
class Annotation
class Object
trait Matchable
class Any
Show all
Generated with