GQL006: Can not match input field to the source field

Cause

This rule triggers when a field defined on a type deriving from InputObjectGraphType<TSourceType> cannot be mapped to the TSourceType type. If the type or one of its base types override the ParseDictionary method the validation is skipped.

Rule description

This diagnostic is reported when the input field name cannot be mapped to any field, property, or public constructor parameter of the TSourceType type. The name comparison is case-insensitive.

How to fix violations

Match the input field name to one the public properties, fields or constructor parameter names of the source type or remove the invalid input field.

Example of a violation

The following example shows an input field named FirstName and a source type with a property named Name:

public class MyInputGraphType : InputObjectGraphType<MySourceType>
{
    public MyInputGraphType()
    {
        Field<StringGraphType>("FirstName");
    }
}

public class MySourceType
{
    public string Name { get; set; }
}

Example of how to fix

Option 1: rename the input field name to match the source type property name

public class MyInputGraphType : InputObjectGraphType<MySourceType>
{
    public MyInputGraphType()
    {
        Field<StringGraphType>("Name");
    }
}

public class MySourceType
{
    public string Name { get; set; }
}

Option 2: rename the source type property name to match the input field name

public class MyInputGraphType : InputObjectGraphType<MySourceType>
{
    public MyInputGraphType()
    {
        Field<StringGraphType>("FirstName");
    }
}

public class MySourceType
{
    public string FirstName { get; set; }
}

Configure the analyzer

If the ParseDictionary method of the analyzed type or any of its base types is overridden, the type analysis is skipped. However, you can manually force the analysis by specifying a comma-delimited list of full type names in the .editorconfig file using the dotnet_diagnostic.input_graph_type_analyzer.force_types_analysis configuration key.

For instance, to enforce the analysis check for both MyServer.BaseInputObjectGraphType and MyServer.BaseInputObjectGraphType2, include the following configuration in your .editorconfig file:

dotnet_diagnostic.input_graph_type_analyzer.force_types_analysis = MyServer.BaseInputObjectGraphType,MyServer.BaseInputObjectGraphType2

Suppress a warning

If you just want to suppress a single violation, add preprocessor directives to your source file to disable and then re-enable the rule.

#pragma warning disable GQL006
// The code that's violating the rule is on this line.
#pragma warning restore GQL006

To disable the rule for a file, folder, or project, set its severity to none in the configuration file.

[*.cs]
dotnet_diagnostic.GQL006.severity = none

For more information, see How to suppress code analysis warnings.

Related rules

GQL007: Can not set source field GQL010: Can not resolve input source type constructor