Update doco

atlassian-labs · Dec 17, 2024 · 48566fa · 48566fa
1 parent 196867a
commit 48566fa
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 4 deletions.
diff --git a/lib/src/main/java/graphql/nadel/validation/NadelAssignableTypeValidation.kt b/lib/src/main/java/graphql/nadel/validation/NadelAssignableTypeValidation.kt
@@ -11,6 +11,7 @@ class NadelAssignableTypeValidation internal constructor(
         overallType: GraphQLType,
         underlyingType: GraphQLType,
     ): Boolean {
+        // Note: the (supplied) value comes from the underlying service, and that value needs to fit the (required) overall field's type
         return isTypeAssignable(
             suppliedType = underlyingType,
             requiredType = overallType,
@@ -25,6 +26,7 @@ class NadelAssignableTypeValidation internal constructor(
         overallType: GraphQLType,
         underlyingType: GraphQLType,
     ): Boolean {
+        // Note: the (supplied) value comes from the user (overall schema) and needs to be assigned to the (required) underlying type
         return isTypeAssignable(
             suppliedType = overallType,
             requiredType = underlyingType,

diff --git a/lib/src/main/java/graphql/nadel/validation/NadelFieldValidation.kt b/lib/src/main/java/graphql/nadel/validation/NadelFieldValidation.kt
@@ -99,8 +99,6 @@ class NadelFieldValidation internal constructor(
                 if (underlyingArg == null) {
                     MissingArgumentOnUnderlying(parent, overallField, underlyingField, overallArg)
                 } else {
-                    // Note: the value comes from the user (overall schema)
-                    // So we are supplying the overall argument to the underlying argument
                     val isArgumentTypeAssignable = assignableTypeValidation.isInputTypeAssignable(
                         overallType = overallArg.type,
                         underlyingType = underlyingArg.type
@@ -189,7 +187,6 @@ class NadelFieldValidation internal constructor(
         overallField: GraphQLFieldDefinition,
         underlyingField: GraphQLFieldDefinition,
     ): NadelSchemaValidationResult {
-        // Note: the value comes from the underlying schema, so we are supplying the underlying field to the overall field
         val isUnderlyingTypeAssignable = assignableTypeValidation.isOutputTypeAssignable(
             overallType = overallField.type,
             underlyingType = underlyingField.type,

diff --git a/lib/src/main/java/graphql/nadel/validation/NadelVirtualTypeValidation.kt b/lib/src/main/java/graphql/nadel/validation/NadelVirtualTypeValidation.kt
@@ -187,7 +187,6 @@ class NadelVirtualTypeValidation internal constructor(
             )
         }
 
-        // Note: the value comes from the backing field, and that value needs to fit the virtual field
         val isOutputTypeAssignable = isOutputTypeAssignable(
             backingField = backingField,
             virtualField = virtualField,
@@ -310,6 +309,7 @@ class NadelVirtualTypeValidation internal constructor(
         backingField: GraphQLFieldDefinition,
         virtualField: GraphQLFieldDefinition,
     ): Boolean {
+        // Note: the (supplied) value comes from the backing service, and that value needs to fit the (required) virtual field's type
         val suppliedType = backingField.type
         val requiredType = virtualField.type