Interface IQueryStringParameterScopeParser

Namespace

JsonApiDotNetCore.Queries.Parsing

Assembly

JsonApiDotNetCore.dll

Parser for the JSON:API 'sort' and 'filter' query string parameter names, which indicate the scope their query string parameter value applies to. The value consists of an optional relationship chain ending in a to-many relationship, surrounded by brackets.

public interface IQueryStringParameterScopeParser

Methods

Parse(string, ResourceType)

Parses the specified source into a QueryStringParameterScopeExpression. Throws a QueryParseException if the input is invalid.

QueryStringParameterScopeExpression Parse(string source, ResourceType resourceType)

Parameters

source string

The source text to read from.

resourceType ResourceType

The resource type used to lookup JSON:API fields that are referenced in source.

Returns

QueryStringParameterScopeExpression