From 3ae666aab64e7d9eaab85d656e9409e07e3b7dea Mon Sep 17 00:00:00 2001 From: Tobe O Date: Sat, 4 Aug 2018 21:52:15 -0400 Subject: [PATCH] Comments on GraphQLFieldInput --- graphql_schema/lib/src/argument.dart | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/graphql_schema/lib/src/argument.dart b/graphql_schema/lib/src/argument.dart index 7fd9cf70..cf9ea795 100644 --- a/graphql_schema/lib/src/argument.dart +++ b/graphql_schema/lib/src/argument.dart @@ -1,9 +1,19 @@ part of graphql_schema.src.schema; +/// An input to a GraphQL field. This is analogous to a function parameter in Dart. class GraphQLFieldInput { + /// The name of this field. final String name; + + /// The type that input values must conform to. final GraphQLType type; + + /// An optional default value for this field. final Value defaultValue; + + /// An optional description for this field. + /// + /// This is useful when documenting your API for consumers like GraphiQL. final String description; /// If [defaultValue] is `null`, and `null` is a valid value for this parameter, set this to `true`.