Skip to content

Commit 2536915

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from df66e6c 
1 parent d273716 commit 2536915

30 files changed

Lines changed: 540 additions & 534 deletions

‎api/JsonApiDotNetCore.AtomicOperations.IOperationsTransaction.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ <h3 id="JsonApiDotNetCore_AtomicOperations_IOperationsTransaction_AfterProcessOp
175175
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/IOperationsTransaction.cs/#L24"><i class="bi bi-code-slash"></i></a>
176176
</h3>
177177

178-
<div class="markdown level1 summary"><p>Enables to execute custom logic after processing of an operation succeeds.</p>
178+
<div class="markdown level1 summary"><p>Enables executing custom logic after processing of an operation succeeds.</p>
179179
</div>
180180
<div class="markdown level1 conceptual"></div>
181181

@@ -212,7 +212,7 @@ <h3 id="JsonApiDotNetCore_AtomicOperations_IOperationsTransaction_BeforeProcessO
212212
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/IOperationsTransaction.cs/#L19"><i class="bi bi-code-slash"></i></a>
213213
</h3>
214214

215-
<div class="markdown level1 summary"><p>Enables to execute custom logic before processing of an operation starts.</p>
215+
<div class="markdown level1 summary"><p>Enables executing custom logic before processing of an operation starts.</p>
216216
</div>
217217
<div class="markdown level1 conceptual"></div>
218218

‎api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -829,7 +829,7 @@ <h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerOptions" data-
829829
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L200"><i class="bi bi-code-slash"></i></a>
830830
</h3>
831831

832-
<div class="markdown level1 summary"><p>Enables to customize the settings that are used by the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializer">JsonSerializer</a>.</p>
832+
<div class="markdown level1 summary"><p>Enables customizing the settings that are used by the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializer">JsonSerializer</a>.</p>
833833
</div>
834834
<div class="markdown level1 conceptual"></div>
835835

@@ -963,8 +963,8 @@ <h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_TransactionIsolationLeve
963963
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L176"><i class="bi bi-code-slash"></i></a>
964964
</h3>
965965

966-
<div class="markdown level1 summary"><p>Enables to override the default isolation level for database transactions, enabling to balance between consistency and performance. Defaults to
967-
<code>null</code>, which leaves this up to Entity Framework Core to choose (and then it varies per database provider).</p>
966+
<div class="markdown level1 summary"><p>Enables overriding the default isolation level for database transactions to balance between consistency and performance. Defaults to <code>null</code>,
967+
which leaves this up to Entity Framework Core to choose (and then it varies per database provider).</p>
968968
</div>
969969
<div class="markdown level1 conceptual"></div>
970970

‎api/JsonApiDotNetCore.Configuration.JsonApiOptions.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -894,7 +894,7 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_SerializerOptions" data-u
894894
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs/#L106"><i class="bi bi-code-slash"></i></a>
895895
</h3>
896896

897-
<div class="markdown level1 summary"><p>Enables to customize the settings that are used by the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializer">JsonSerializer</a>.</p>
897+
<div class="markdown level1 summary"><p>Enables customizing the settings that are used by the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.text.json.jsonserializer">JsonSerializer</a>.</p>
898898
</div>
899899
<div class="markdown level1 conceptual"></div>
900900

@@ -964,8 +964,8 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_TransactionIsolationLevel
964964
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs/#L100"><i class="bi bi-code-slash"></i></a>
965965
</h3>
966966

967-
<div class="markdown level1 summary"><p>Enables to override the default isolation level for database transactions, enabling to balance between consistency and performance. Defaults to
968-
<code>null</code>, which leaves this up to Entity Framework Core to choose (and then it varies per database provider).</p>
967+
<div class="markdown level1 summary"><p>Enables overriding the default isolation level for database transactions to balance between consistency and performance. Defaults to <code>null</code>,
968+
which leaves this up to Entity Framework Core to choose (and then it varies per database provider).</p>
969969
</div>
970970
<div class="markdown level1 conceptual"></div>
971971

‎api/JsonApiDotNetCore.Middleware.AsyncConvertEmptyActionResultFilter.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,16 +157,16 @@ <h1 id="JsonApiDotNetCore_Middleware_AsyncConvertEmptyActionResultFilter" data-u
157157

158158

159159
<h2 id="JsonApiDotNetCore_Middleware_AsyncConvertEmptyActionResultFilter_remarks">Remarks</h2>
160-
<div class="markdown level0 remarks"><p>This basically turns calls such as
160+
<div class="markdown level0 remarks"><p>This converts calls such as:
161161
<code>
162162
return NotFound()
163163
</code>
164-
into
164+
into:
165165
<code>
166166
return NotFound(null)
167167
</code>
168168
, so that our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
169-
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
169+
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a>.</p>
170170
</div>
171171

172172

‎api/JsonApiDotNetCore.Middleware.IAsyncConvertEmptyActionResultFilter.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,16 +127,16 @@ <h1 id="JsonApiDotNetCore_Middleware_IAsyncConvertEmptyActionResultFilter" data-
127127

128128

129129
<h2 id="JsonApiDotNetCore_Middleware_IAsyncConvertEmptyActionResultFilter_remarks">Remarks</h2>
130-
<div class="markdown level0 remarks"><p>This basically turns calls such as
130+
<div class="markdown level0 remarks"><p>This converts calls such as:
131131
<code>
132132
return NotFound()
133133
</code>
134-
into
134+
into:
135135
<code>
136136
return NotFound(null)
137137
</code>
138138
, so that our formatter is invoked, where we'll build a JSON:API compliant response. For details, see:
139-
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a></p>
139+
<a href="https://github.com/dotnet/aspnetcore/issues/16969">https://github.com/dotnet/aspnetcore/issues/16969</a>.</p>
140140
</div>
141141

142142

‎api/JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Interface IJsonApiEndpointFilter ">
88

9-
<meta name="description" content="Enables to remove JSON:API controller action methods at startup. For atomic:operation requests, see .">
9+
<meta name="description" content="Enables removing JSON:API controller action methods at startup. For atomic:operation requests, see .">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -100,7 +100,7 @@ <h1 id="JsonApiDotNetCore_Middleware_IJsonApiEndpointFilter" data-uid="JsonApiDo
100100
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101101
</div>
102102

103-
<div class="markdown summary"><p>Enables to remove JSON:API controller action methods at startup. For atomic:operation requests, see <a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a>.</p>
103+
<div class="markdown summary"><p>Enables removing JSON:API controller action methods at startup. For atomic:operation requests, see <a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a>.</p>
104104
</div>
105105
<div class="markdown conceptual"></div>
106106

‎api/JsonApiDotNetCore.Middleware.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ <h3 id="interfaces">
202202
</dl>
203203
<dl class="jumplist">
204204
<dt><a class="xref" href="JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.html">IJsonApiEndpointFilter</a></dt>
205-
<dd><p>Enables to remove JSON:API controller action methods at startup. For atomic:operation requests, see <a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a>.</p>
205+
<dd><p>Enables removing JSON:API controller action methods at startup. For atomic:operation requests, see <a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a>.</p>
206206
</dd>
207207
</dl>
208208
<dl class="jumplist">

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Class AnyExpression ">
88

9-
<meta name="description" content="This expression allows to test if an attribute value equals any of the specified constants. It represents the &amp;quot;any&amp;quot; filter function, resulting from text such as: any(owner.name,&#39;Jack&#39;,&#39;Joe&#39;,&#39;John&#39;) .">
9+
<meta name="description" content="This expression tests if an attribute value equals any of the specified constants. It represents the &amp;quot;any&amp;quot; filter function, resulting from text such as: any(owner.name,&#39;Jack&#39;,&#39;Joe&#39;,&#39;John&#39;) .">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -100,8 +100,8 @@ <h1 id="JsonApiDotNetCore_Queries_Expressions_AnyExpression" data-uid="JsonApiDo
100100
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101101
</div>
102102

103-
<div class="markdown summary"><p>This expression allows to test if an attribute value equals any of the specified constants. It represents the &quot;any&quot; filter function, resulting from
104-
text such as:
103+
<div class="markdown summary"><p>This expression tests if an attribute value equals any of the specified constants. It represents the &quot;any&quot; filter function, resulting from text such
104+
as:
105105
<code>
106106
any(owner.name,'Jack','Joe','John')
107107
</code>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Class ComparisonExpression ">
88

9-
<meta name="description" content="This expression allows to compare two operands using a comparison operator. It represents comparison filter functions, resulting from text such as: equals(name,&#39;Joe&#39;) , equals(owner,null) , or: greaterOrEqual(count(upVotes),count(downVotes),&#39;1&#39;) .">
9+
<meta name="description" content="This expression compares two operands using a comparison operator. It represents comparison filter functions, resulting from text such as: equals(name,&#39;Joe&#39;) , equals(owner,null) , or: greaterOrEqual(count(upVotes),count(downVotes),&#39;1&#39;) .">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -100,7 +100,7 @@ <h1 id="JsonApiDotNetCore_Queries_Expressions_ComparisonExpression" data-uid="Js
100100
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101101
</div>
102102

103-
<div class="markdown summary"><p>This expression allows to compare two operands using a comparison operator. It represents comparison filter functions, resulting from text such as:
103+
<div class="markdown summary"><p>This expression compares two operands using a comparison operator. It represents comparison filter functions, resulting from text such as:
104104
<code>
105105
equals(name,'Joe')
106106
</code>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
77
<meta name="title" content="Class CountExpression ">
88

9-
<meta name="description" content="This expression allows to determine the number of related resources in a to-many relationship. It represents the &amp;quot;count&amp;quot; function, resulting from text such as: count(articles) .">
9+
<meta name="description" content="This expression determines the number of related resources in a to-many relationship. It represents the &amp;quot;count&amp;quot; function, resulting from text such as: count(articles) .">
1010
<link rel="icon" href="../favicon.ico">
1111
<link rel="stylesheet" href="../public/docfx.min.css">
1212
<link rel="stylesheet" href="../public/main.css">
@@ -100,8 +100,8 @@ <h1 id="JsonApiDotNetCore_Queries_Expressions_CountExpression" data-uid="JsonApi
100100
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101101
</div>
102102

103-
<div class="markdown summary"><p>This expression allows to determine the number of related resources in a to-many relationship. It represents the &quot;count&quot; function, resulting from
104-
text such as:
103+
<div class="markdown summary"><p>This expression determines the number of related resources in a to-many relationship. It represents the &quot;count&quot; function, resulting from text such
104+
as:
105105
<code>
106106
count(articles)
107107
</code>

0 commit comments

Comments
 (0)