GraphQL.NET mutation with a List> | JSON string

Question

I want to register alarms on my server application. To prevent passing 10+ arguments, I serialize my alarm on client side and pass it as List<JSONString> to my server. Deserialize it, register it and give the answer of an registered alarm.

Now my problem is, that I don't know how to pass these parameters:

Using Mutation - DictionaryType

"Variable \"$params\" of type \"[String]!\" used in position expecting type \"[DictionaryType]!\"."

Using Mutation - StringGraphType

"Cannot convert value to AST: System.Collections.Generic.Dictionary`2[System.String,System.Object]",**

Server

Mutation - DictionaryType

public class Mutation : ObjectGraphType
{
    public Mutation()
    {
        Name = "Mutation";

        FieldAsync<HtStaticAlarmBaseType>(
            "registerStaticAlarms",
            "Register a list with static alarms.",
            arguments: new QueryArguments(
                new QueryArgument<NonNullGraphType<ListGraphType<DictionaryType>>> {Name = "params"}
            ),
            resolve: async context =>
            {
                List<object> parameterString = context.GetArgument<List<object>>("params");

                //TODO

                return null;
            }
        );
    }
}

Mutation - DictionaryType

public class Mutation : ObjectGraphType
{
    public Mutation()
    {
        Name = "Mutation";

        FieldAsync<HtStaticAlarmBaseType>(
            "registerStaticAlarms",
            "Register a list with static alarms.",
            arguments: new QueryArguments(
                new QueryArgument<NonNullGraphType<ListGraphType<StringGraphType>>> {Name = "params"}
            ),
            resolve: async context =>
            {
                List<object> parameterString = context.GetArgument<List<object>>("params");

                //TODO

                return null;
            }
        );
    }
}

DictionaryType

public class DictionaryType : ObjectGraphType<Dictionary<string,string>>
{
    public DictionaryType()
    {
        Name = "DictionaryType";
        Description = "Dictionary of type string, string.";
    }
}

HtStaticAlarmBaseType

public class HtStaticAlarmBaseType : ObjectGraphType<HtStaticAlarmBase>
{
    public HtStaticAlarmBaseType()
    {
        Name = "HtStaticAlarmBase";
        Description = "Base class of a static alarm.";


        // ##################################################
        // HtAlarmBase
        // ##################################################

        #region HtAlarmBase

        Field<StringGraphType>(
            "AlarmClass",
            resolve: context => context.Source.AlarmClass.ToString());

        Field<StringGraphType>(
            "AlarmGroup",
            resolve: context => context.Source.AlarmGroup);

        Field<IntGraphType>(
            "ErrorCode",
            resolve: context => (int)context.Source.ErrorCode);

        Field<StringGraphType>(
            "Id",
            resolve: context => context.Source.Id.ToString());

        Field<StringGraphType>(
            "Message",
            resolve: context => context.Source.Message);

        Field<StringGraphType>(
            "Station",
            resolve: context => context.Source.Station);

        Field<StringGraphType>(
            "TimeStampCome",
            resolve: context => context.Source.TimeStampCome?.ToString());

        Field<StringGraphType>(
            "TimeStampGone",
            resolve: context => context.Source.TimeStampGone?.ToString());

        Field<StringGraphType>(
            "TimeStampAcknowledge",
            resolve: context => context.Source.TimeStampAcknowledge?.ToString());

        Field<StringGraphType>(
            "Origin",
            resolve: context => context.Source.Origin);

        #endregion

        Field<IntGraphType>(
            "Number",
            resolve: context => context.Source.Number);

        Field<BooleanGraphType>(
            "Active",
            resolve: context => context.Source.Active);
    }
}

Answer 1

Actually this is my current workingsolution:

Query for the client

mutation RegisterStaticAlarms($params: [HtStaticAlarmInputType])
{
    registerStaticAlarms(params: $params)
    {
        id,
        number,
        message,
        errorCode
    }
}

Mutation

public class Mutation : ObjectGraphType
{
    public Mutation()
    {
        Name = "Mutation";

        Field<ListGraphType<HtStaticAlarmType>>(
            "registerStaticAlarms",
            arguments: new QueryArguments(
                new QueryArgument<ListGraphType<HtStaticAlarmInputType>>
                {
                    Name = "params"
                }
            ),
            resolve: context =>
            {
                List<HtStaticAlarmInputTypeParams> paramses = context.GetArgument<List<HtStaticAlarmInputTypeParams>>("params");

                List<HtStaticAlarmBase> list = new List<HtStaticAlarmBase>();
                foreach (HtStaticAlarmInputTypeParams p in paramses)
                {
                    list.Add(HtAlarmManager.Create(p.Origin, (EHtAlarmClassType)Enum.Parse(typeof(EHtAlarmClassType), p.AlarmClass.ToString()), p.AlarmGroup, p.Station, (HtErrorCode)Enum.Parse(typeof(HtErrorCode), p.ErrorCode.ToString()), p.Message, p.Number));
                }

                return list;
            }
        );            
    }
}

Type and Model

/// <summary>
/// GraphQl type of the <see cref="HtStaticAlarmBase"/>
/// </summary>
internal class HtStaticAlarmType : ObjectGraphType<HtStaticAlarmBase>
{
    public HtStaticAlarmType()
    {
        Name = "HtStaticAlarmType";
        Description = "Base class of a static alarm.";


        // ##################################################
        // HtAlarmBase
        // ##################################################

        #region HtAlarmBase

        Field<StringGraphType>(
            "AlarmClass",
            resolve: context => context.Source.AlarmClass.ToString());

        Field<StringGraphType>(
            "AlarmGroup",
            resolve: context => context.Source.AlarmGroup);

        Field<IntGraphType>(
            "ErrorCode",
            resolve: context => (int)context.Source.ErrorCode);

        Field<StringGraphType>(
            "Id",
            resolve: context => context.Source.Id.ToString());

        Field<StringGraphType>(
            "Message",
            resolve: context => context.Source.Message);

        Field<StringGraphType>(
            "Station",
            resolve: context => context.Source.Station);

        Field<StringGraphType>(
            "TimeStampCome",
            resolve: context => context.Source.TimeStampCome?.ToString());

        Field<StringGraphType>(
            "TimeStampGone",
            resolve: context => context.Source.TimeStampGone?.ToString());

        Field<StringGraphType>(
            "TimeStampAcknowledge",
            resolve: context => context.Source.TimeStampAcknowledge?.ToString());

        Field<StringGraphType>(
            "Origin",
            resolve: context => context.Source.Origin);

        #endregion

        Field<IntGraphType>(
            "Number",
            resolve: context => context.Source.Number);

        Field<BooleanGraphType>(
            "Active",
            resolve: context => context.Source.Active);
    }
}

/// <summary>
/// GraphQL input type of the <see cref="HtStaticAlarmBase"/>
/// </summary>
internal class HtStaticAlarmInputType : InputObjectGraphType
{
    public HtStaticAlarmInputType()
    {
        Name = "HtStaticAlarmInputType";
        Description = "Base class of a static alarm.";

        // ##################################################
        // HtAlarmBase
        // ##################################################

        #region HtAlarmBase

        Field<IntGraphType>("AlarmClass");
        Field<StringGraphType>("AlarmGroup");
        Field<IntGraphType>("ErrorCode");
        Field<StringGraphType>("Id");
        Field<StringGraphType>("Message");
        Field<StringGraphType>("Station");
        Field<DateGraphType>("TimeStampCome");
        Field<DateGraphType>("TimeStampGone");
        Field<DateGraphType>("TimeStampAcknowledge");
        Field<StringGraphType>("Origin");
        Field<StringGraphType>("IsSynced");
        Field<StringGraphType>("Pending");

        #endregion

        Field<IntGraphType>("Number");
        Field<BooleanGraphType>("Active");            
    }
}

/// <summary>
/// A lightweight class to deserialize the incoming <see cref="HtStaticAlarmInputType"/>
/// </summary>
internal class HtStaticAlarmInputTypeParams
{
    public int AlarmClass { get; set; }
    public string AlarmGroup { get; set; }
    public int ErrorCode { get; set; }
    public string Message { get; set; }
    public string Station { get; set; }
    public DateTime TimeStampCome { get; set; }
    public DateTime TimeStampGone { get; set; }
    public DateTime TimeStampAcknowledge { get; set; }
    public string Origin { get; set; }

    public int Number { get; set; }
    public bool Active { get; set; }
}

Preview

• It would be also possible to include the properties in the HtStaticAlarmInputType. But I don't want to have that overhead and created a lightweight class HtStaticAlarmInputTypeParams.

• It's important to use a CamelCasePropertyNamesContractResolver if you want to use JSON (https://stackoverflow.com/a/36884359/6229375).

• This solution is based on https://gist.github.com/DanielRobinsonSoftware/9ef4aa2834f2c912b5a3d4ef63ba6188