Skip to content

Commit f72e8ae

Browse files
authored
Merge pull request #464 from wisepotato/feat/docs
feat: added extra information to FilterQuery
2 parents 2a8a02f + 0158da3 commit f72e8ae

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Diff for: src/JsonApiDotNetCore/Internal/Query/FilterQuery.cs

+11
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,19 @@
44

55
namespace JsonApiDotNetCore.Internal.Query
66
{
7+
/// <summary>
8+
/// Allows you to filter the query, via the methods shown at
9+
/// <see href="https://json-api-dotnet.github.io/#/filtering">HERE</see>
10+
/// </summary>
711
public class FilterQuery : BaseQuery
812
{
13+
/// <summary>
14+
/// Allows you to filter the query, via the methods shown at
15+
/// <see href="https://json-api-dotnet.github.io/#/filtering">HERE</see>
16+
/// </summary>
17+
/// <param name="attribute">the json attribute you want to filter on</param>
18+
/// <param name="value">the value this attribute should be</param>
19+
/// <param name="operation">possible values: eq, ne, lt, gt, le, ge, like, in (default)</param>
920
public FilterQuery(string attribute, string value, string operation)
1021
: base(attribute)
1122
{

0 commit comments

Comments
 (0)