feat(#171): allow custom query parameters

Author: jaredcnance

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -15,6 +15,15 @@ public class JsonApiOptions
         public bool AllowClientGeneratedIds { get; set; }
         public IContextGraph ContextGraph { get; set; }
         public bool RelativeLinks { get; set; }
+
+        /// <summary>
+        /// This flag is experimental and could be perceived as a violation
+        /// of the v1 spec. However, we have decided that this is a real
+        /// requirement for users of this library and a gap in the specification.
+        /// It will likely be removed when the spec is updated to support this
+        /// requirement. 
+        /// </summary>
+        public bool AllowCustomQueryParameters { get; set; }
         public IContractResolver JsonContractResolver { get; set; } = new DasherizedResolver();
         internal IContextGraphBuilder ContextGraphBuilder { get; } = new ContextGraphBuilder();
 

src/JsonApiDotNetCore/Internal/Query/QuerySet.cs

@@ -68,7 +68,8 @@ private void BuildQuerySet(IQueryCollection query)
                     continue;
                 }
 
-                throw new JsonApiException(400, $"{pair} is not a valid query.");
+                if (_jsonApiContext.Options.AllowCustomQueryParameters == false)
+                    throw new JsonApiException(400, $"{pair} is not a valid query.");
             }
         }
 
@@ -101,9 +102,9 @@ private List<FilterQuery> ParseFilterQuery(string key, string value)
                 return (string.Empty, value);
 
             // remove prefix from value
-            if(Enum.TryParse(operation[0], out FilterOperations op) == false)
+            if (Enum.TryParse(operation[0], out FilterOperations op) == false)
                 return (string.Empty, value);
-            
+
             var prefix = operation[0];
             value = string.Join(":", operation.Skip(1));
 

src/JsonApiDotNetCore/JsonApiDotNetCore.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <VersionPrefix>2.1.5</VersionPrefix>
+    <VersionPrefix>2.1.6</VersionPrefix>
     <TargetFrameworks>netstandard1.6</TargetFrameworks>
     <AssemblyName>JsonApiDotNetCore</AssemblyName>
     <PackageId>JsonApiDotNetCore</PackageId>