Skip to content

Commit 21d87e0

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 4b7a47c 
1 parent a29046e commit 21d87e0

5 files changed

Lines changed: 500 additions & 500 deletions

‎api/JsonApiDotNetCore.Queries.Expressions.AnyExpression.html‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -161,21 +161,21 @@ <h2 class="section" id="constructors">Constructors
161161

162162
<a id="JsonApiDotNetCore_Queries_Expressions_AnyExpression__ctor_" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.#ctor*"></a>
163163

164-
<h3 id="JsonApiDotNetCore_Queries_Expressions_AnyExpression__ctor_JsonApiDotNetCore_Queries_Expressions_ResourceFieldChainExpression_System_Collections_Immutable_IImmutableSet_JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression__" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.#ctor(JsonApiDotNetCore.Queries.Expressions.ResourceFieldChainExpression,System.Collections.Immutable.IImmutableSet{JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression})">
165-
AnyExpression(ResourceFieldChainExpression, IImmutableSet&lt;LiteralConstantExpression&gt;)
164+
<h3 id="JsonApiDotNetCore_Queries_Expressions_AnyExpression__ctor_JsonApiDotNetCore_Queries_Expressions_QueryExpression_System_Collections_Immutable_IImmutableSet_JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression__" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.#ctor(JsonApiDotNetCore.Queries.Expressions.QueryExpression,System.Collections.Immutable.IImmutableSet{JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression})">
165+
AnyExpression(QueryExpression, IImmutableSet&lt;LiteralConstantExpression&gt;)
166166
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/AnyExpression.cs/#L29"><i class="bi bi-code-slash"></i></a>
167167
</h3>
168168

169169
<div class="markdown level1 summary"></div>
170170
<div class="markdown level1 conceptual"></div>
171171

172172
<div class="codewrapper">
173-
<pre><code class="lang-csharp hljs">public AnyExpression(ResourceFieldChainExpression targetAttribute, IImmutableSet&lt;LiteralConstantExpression&gt; constants)</code></pre>
173+
<pre><code class="lang-csharp hljs">public AnyExpression(QueryExpression matchTarget, IImmutableSet&lt;LiteralConstantExpression&gt; constants)</code></pre>
174174
</div>
175175

176176
<h4 class="section">Parameters</h4>
177177
<dl class="parameters">
178-
<dt><code>targetAttribute</code> <a class="xref" href="JsonApiDotNetCore.Queries.Expressions.ResourceFieldChainExpression.html">ResourceFieldChainExpression</a></dt>
178+
<dt><code>matchTarget</code> <a class="xref" href="JsonApiDotNetCore.Queries.Expressions.QueryExpression.html">QueryExpression</a></dt>
179179
<dd></dd>
180180
<dt><code>constants</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.immutable.iimmutableset-1">IImmutableSet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.html">LiteralConstantExpression</a>&gt;</dt>
181181
<dd></dd>
@@ -228,19 +228,19 @@ <h4 class="section">Property Value</h4>
228228

229229

230230

231-
<a id="JsonApiDotNetCore_Queries_Expressions_AnyExpression_TargetAttribute_" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.TargetAttribute*"></a>
231+
<a id="JsonApiDotNetCore_Queries_Expressions_AnyExpression_MatchTarget_" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.MatchTarget*"></a>
232232

233-
<h3 id="JsonApiDotNetCore_Queries_Expressions_AnyExpression_TargetAttribute" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.TargetAttribute">
234-
TargetAttribute
233+
<h3 id="JsonApiDotNetCore_Queries_Expressions_AnyExpression_MatchTarget" data-uid="JsonApiDotNetCore.Queries.Expressions.AnyExpression.MatchTarget">
234+
MatchTarget
235235
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/AnyExpression.cs/#L22"><i class="bi bi-code-slash"></i></a>
236236
</h3>
237237

238-
<div class="markdown level1 summary"><p>The attribute whose value to compare. Chain format: an optional list of to-one relationships, followed by an attribute.</p>
238+
<div class="markdown level1 summary"><p>The function or attribute whose value to compare. Attribute chain format: an optional list of to-one relationships, followed by an attribute.</p>
239239
</div>
240240
<div class="markdown level1 conceptual"></div>
241241

242242
<div class="codewrapper">
243-
<pre><code class="lang-csharp hljs">public ResourceFieldChainExpression TargetAttribute { get; }</code></pre>
243+
<pre><code class="lang-csharp hljs">public QueryExpression MatchTarget { get; }</code></pre>
244244
</div>
245245

246246

@@ -249,7 +249,7 @@ <h3 id="JsonApiDotNetCore_Queries_Expressions_AnyExpression_TargetAttribute" dat
249249

250250
<h4 class="section">Property Value</h4>
251251
<dl class="parameters">
252-
<dt><a class="xref" href="JsonApiDotNetCore.Queries.Expressions.ResourceFieldChainExpression.html">ResourceFieldChainExpression</a></dt>
252+
<dt><a class="xref" href="JsonApiDotNetCore.Queries.Expressions.QueryExpression.html">QueryExpression</a></dt>
253253
<dd></dd>
254254
</dl>
255255

‎api/JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -169,21 +169,21 @@ <h2 class="section" id="constructors">Constructors
169169

170170
<a id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression__ctor_" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.#ctor*"></a>
171171

172-
<h3 id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression__ctor_JsonApiDotNetCore_Queries_Expressions_ResourceFieldChainExpression_JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_JsonApiDotNetCore_Queries_Expressions_TextMatchKind_" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.#ctor(JsonApiDotNetCore.Queries.Expressions.ResourceFieldChainExpression,JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression,JsonApiDotNetCore.Queries.Expressions.TextMatchKind)">
173-
MatchTextExpression(ResourceFieldChainExpression, LiteralConstantExpression, TextMatchKind)
172+
<h3 id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression__ctor_JsonApiDotNetCore_Queries_Expressions_QueryExpression_JsonApiDotNetCore_Queries_Expressions_LiteralConstantExpression_JsonApiDotNetCore_Queries_Expressions_TextMatchKind_" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.#ctor(JsonApiDotNetCore.Queries.Expressions.QueryExpression,JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression,JsonApiDotNetCore.Queries.Expressions.TextMatchKind)">
173+
MatchTextExpression(QueryExpression, LiteralConstantExpression, TextMatchKind)
174174
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/MatchTextExpression.cs/#L41"><i class="bi bi-code-slash"></i></a>
175175
</h3>
176176

177177
<div class="markdown level1 summary"></div>
178178
<div class="markdown level1 conceptual"></div>
179179

180180
<div class="codewrapper">
181-
<pre><code class="lang-csharp hljs">public MatchTextExpression(ResourceFieldChainExpression targetAttribute, LiteralConstantExpression textValue, TextMatchKind matchKind)</code></pre>
181+
<pre><code class="lang-csharp hljs">public MatchTextExpression(QueryExpression matchTarget, LiteralConstantExpression textValue, TextMatchKind matchKind)</code></pre>
182182
</div>
183183

184184
<h4 class="section">Parameters</h4>
185185
<dl class="parameters">
186-
<dt><code>targetAttribute</code> <a class="xref" href="JsonApiDotNetCore.Queries.Expressions.ResourceFieldChainExpression.html">ResourceFieldChainExpression</a></dt>
186+
<dt><code>matchTarget</code> <a class="xref" href="JsonApiDotNetCore.Queries.Expressions.QueryExpression.html">QueryExpression</a></dt>
187187
<dd></dd>
188188
<dt><code>textValue</code> <a class="xref" href="JsonApiDotNetCore.Queries.Expressions.LiteralConstantExpression.html">LiteralConstantExpression</a></dt>
189189
<dd></dd>
@@ -238,19 +238,19 @@ <h4 class="section">Property Value</h4>
238238

239239

240240

241-
<a id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression_TargetAttribute_" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.TargetAttribute*"></a>
241+
<a id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression_MatchTarget_" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.MatchTarget*"></a>
242242

243-
<h3 id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression_TargetAttribute" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.TargetAttribute">
244-
TargetAttribute
243+
<h3 id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression_MatchTarget" data-uid="JsonApiDotNetCore.Queries.Expressions.MatchTextExpression.MatchTarget">
244+
MatchTarget
245245
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/MatchTextExpression.cs/#L29"><i class="bi bi-code-slash"></i></a>
246246
</h3>
247247

248-
<div class="markdown level1 summary"><p>The attribute whose value to match. Chain format: an optional list of to-one relationships, followed by an attribute.</p>
248+
<div class="markdown level1 summary"><p>The function or attribute whose value to match. Attribute chain format: an optional list of to-one relationships, followed by an attribute.</p>
249249
</div>
250250
<div class="markdown level1 conceptual"></div>
251251

252252
<div class="codewrapper">
253-
<pre><code class="lang-csharp hljs">public ResourceFieldChainExpression TargetAttribute { get; }</code></pre>
253+
<pre><code class="lang-csharp hljs">public QueryExpression MatchTarget { get; }</code></pre>
254254
</div>
255255

256256

@@ -259,7 +259,7 @@ <h3 id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression_TargetAttribut
259259

260260
<h4 class="section">Property Value</h4>
261261
<dl class="parameters">
262-
<dt><a class="xref" href="JsonApiDotNetCore.Queries.Expressions.ResourceFieldChainExpression.html">ResourceFieldChainExpression</a></dt>
262+
<dt><a class="xref" href="JsonApiDotNetCore.Queries.Expressions.QueryExpression.html">QueryExpression</a></dt>
263263
<dd></dd>
264264
</dl>
265265

@@ -277,7 +277,7 @@ <h3 id="JsonApiDotNetCore_Queries_Expressions_MatchTextExpression_TextValue" dat
277277
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Expressions/MatchTextExpression.cs/#L34"><i class="bi bi-code-slash"></i></a>
278278
</h3>
279279

280-
<div class="markdown level1 summary"><p>The text to match the attribute's value against.</p>
280+
<div class="markdown level1 summary"><p>The text to match against.</p>
281281
</div>
282282
<div class="markdown level1 conceptual"></div>
283283

‎api/JsonApiDotNetCore.Queries.Parsing.FilterParser.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ <h2 class="section" id="methods">Methods
272272

273273
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_GetConstantValueConverterForType_System_Type_" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.GetConstantValueConverterForType(System.Type)">
274274
GetConstantValueConverterForType(Type)
275-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L523"><i class="bi bi-code-slash"></i></a>
275+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L558"><i class="bi bi-code-slash"></i></a>
276276
</h3>
277277

278278
<div class="markdown level1 summary"></div>
@@ -308,7 +308,7 @@ <h4 class="section">Returns</h4>
308308

309309
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_InScopeOfResourceType_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.InScopeOfResourceType(JsonApiDotNetCore.Configuration.ResourceType)">
310310
InScopeOfResourceType(ResourceType)
311-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L582"><i class="bi bi-code-slash"></i></a>
311+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L617"><i class="bi bi-code-slash"></i></a>
312312
</h3>
313313

314314
<div class="markdown level1 summary"><p>Changes the resource type currently in scope and restores the original resource type when the return value is disposed.</p>
@@ -422,7 +422,7 @@ <h4 class="section">Returns</h4>
422422

423423
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_ParseAny" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.ParseAny">
424424
ParseAny()
425-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L347"><i class="bi bi-code-slash"></i></a>
425+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L366"><i class="bi bi-code-slash"></i></a>
426426
</h3>
427427

428428
<div class="markdown level1 summary"></div>
@@ -551,7 +551,7 @@ <h4 class="section">Returns</h4>
551551

552552
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_ParseHas" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.ParseHas">
553553
ParseHas()
554-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L380"><i class="bi bi-code-slash"></i></a>
554+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L415"><i class="bi bi-code-slash"></i></a>
555555
</h3>
556556

557557
<div class="markdown level1 summary"></div>
@@ -582,7 +582,7 @@ <h4 class="section">Returns</h4>
582582

583583
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_ParseIsType" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.ParseIsType">
584584
ParseIsType()
585-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L407"><i class="bi bi-code-slash"></i></a>
585+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L442"><i class="bi bi-code-slash"></i></a>
586586
</h3>
587587

588588
<div class="markdown level1 summary"></div>
@@ -716,7 +716,7 @@ <h4 class="section">Returns</h4>
716716

717717
<h3 id="JsonApiDotNetCore_Queries_Parsing_FilterParser_ValidateField_JsonApiDotNetCore_Resources_Annotations_ResourceFieldAttribute_System_Int32_" data-uid="JsonApiDotNetCore.Queries.Parsing.FilterParser.ValidateField(JsonApiDotNetCore.Resources.Annotations.ResourceFieldAttribute,System.Int32)">
718718
ValidateField(ResourceFieldAttribute, int)
719-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L568"><i class="bi bi-code-slash"></i></a>
719+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Queries/Parsing/FilterParser.cs/#L603"><i class="bi bi-code-slash"></i></a>
720720
</h3>
721721

722722
<div class="markdown level1 summary"><p>Enables derived types to throw a <a class="xref" href="JsonApiDotNetCore.Queries.Parsing.QueryParseException.html">QueryParseException</a> when usage of a JSON:API field inside a field chain is not permitted.</p>

0 commit comments

Comments
 (0)