apollo-ast/com.apollographql.apollo3.ast/Issue

Issue

sealed class Issue

All the issues that can be collected while analyzing a graphql document

Types

class ConditionalFragment(val message: String, val sourceLocation: SourceLocation) : Issue

A fragment has an @include or @skip directive. While this is valid GraphQL, the responseBased codegen does not support that

DeprecatedUsage

class DeprecatedUsage(val message: String, val sourceLocation: SourceLocation) : Issue

A deprecated field/enum is used

ParsingError

class ParsingError(val message: String, val sourceLocation: SourceLocation) : Issue

A grammar error

ReservedEnumValueName

class ReservedEnumValueName(val message: String, val sourceLocation: SourceLocation) : Issue

Certain enum value names such as type are reserved for Apollo.

Severity

enum Severity : Enum<Issue.Severity>

UnusedVariable

class UnusedVariable(val message: String, val sourceLocation: SourceLocation) : Issue

A variable is unused

UpperCaseField

class UpperCaseField(val message: String, val sourceLocation: SourceLocation) : Issue

When models are nested, upper case fields are not supported as Kotlin doesn't allow a property name with the same name as a nested class. If this happens, the easiest solution is to add an alias with a lower case first letter. If there are a lot of such fields, the Apollo compiler option flattenModels can also be used to circumvent this error at the price of possible suffixes in model names.

ValidationError

class ValidationError( val message: String, val sourceLocation: SourceLocation, val severity: Issue.Severity = Severity.ERROR, val details: ValidationDetails = ValidationDetails.Other) : Issue

A GraphqQL validation error as per the spec

Properties

message

val message: String

severity

val severity: Issue.Severity

sourceLocation

val sourceLocation: SourceLocation

Inheritors