Skip to content

Commit 75a70f9

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from cd8ae40 
1 parent b99f9f9 commit 75a70f9

10 files changed

+538
-469
lines changed

‎api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html‎

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ <h2 class="section" id="properties">Properties
128128

129129
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_AllowClientGeneratedIds" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.AllowClientGeneratedIds">
130130
AllowClientGeneratedIds
131-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L141"><i class="bi bi-code-slash"></i></a>
131+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L142"><i class="bi bi-code-slash"></i></a>
132132
</h3>
133133

134134
<div class="markdown level1 summary"><p>Whether clients can provide IDs when creating resources. When not allowed, a 403 Forbidden response is returned if a client attempts to create a
@@ -167,7 +167,7 @@ <h4 class="section" id="JsonApiDotNetCore_Configuration_IJsonApiOptions_AllowCli
167167

168168
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_AllowUnknownFieldsInRequestBody" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.AllowUnknownFieldsInRequestBody">
169169
AllowUnknownFieldsInRequestBody
170-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L153"><i class="bi bi-code-slash"></i></a>
170+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L154"><i class="bi bi-code-slash"></i></a>
171171
</h3>
172172

173173
<div class="markdown level1 summary"><p>Whether to produce an error on unknown attribute and relationship keys in request bodies. <code>false</code> by default.</p>
@@ -199,7 +199,7 @@ <h4 class="section">Property Value</h4>
199199

200200
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_AllowUnknownQueryStringParameters" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.AllowUnknownQueryStringParameters">
201201
AllowUnknownQueryStringParameters
202-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L148"><i class="bi bi-code-slash"></i></a>
202+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L149"><i class="bi bi-code-slash"></i></a>
203203
</h3>
204204

205205
<div class="markdown level1 summary"><p>Whether to produce an error on unknown query string parameters. <code>false</code> by default.</p>
@@ -231,7 +231,7 @@ <h4 class="section">Property Value</h4>
231231

232232
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_ClientIdGeneration" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.ClientIdGeneration">
233233
ClientIdGeneration
234-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L131"><i class="bi bi-code-slash"></i></a>
234+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L132"><i class="bi bi-code-slash"></i></a>
235235
</h3>
236236

237237
<div class="markdown level1 summary"><p>Whether clients are allowed or required to provide IDs when creating resources. <a class="xref" href="JsonApiDotNetCore.Configuration.ClientIdGenerationMode.html#JsonApiDotNetCore_Configuration_ClientIdGenerationMode_Forbidden">Forbidden</a> by default. This
@@ -363,10 +363,11 @@ <h4 class="section">Property Value</h4>
363363

364364
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_DefaultPageSize" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.DefaultPageSize">
365365
DefaultPageSize
366-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L110"><i class="bi bi-code-slash"></i></a>
366+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L111"><i class="bi bi-code-slash"></i></a>
367367
</h3>
368368

369-
<div class="markdown level1 summary"><p>The page size (10 by default) that is used when not specified in query string. Set to <code>null</code> to not use pagination by default.</p>
369+
<div class="markdown level1 summary"><p>The page size (10 by default) that is used when not specified in query string. Set to <code>null</code> to not use pagination by default. This setting can
370+
be overruled per relationship by setting <a class="xref" href="JsonApiDotNetCore.Resources.Annotations.HasManyAttribute.html#JsonApiDotNetCore_Resources_Annotations_HasManyAttribute_DisablePagination">DisablePagination</a> to <code>true</code>.</p>
370371
</div>
371372
<div class="markdown level1 conceptual"></div>
372373

@@ -395,7 +396,7 @@ <h4 class="section">Property Value</h4>
395396

396397
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_EnableLegacyFilterNotation" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.EnableLegacyFilterNotation">
397398
EnableLegacyFilterNotation
398-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L158"><i class="bi bi-code-slash"></i></a>
399+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L159"><i class="bi bi-code-slash"></i></a>
399400
</h3>
400401

401402
<div class="markdown level1 summary"><p>Determines whether legacy filter notation in query strings (such as =eq:, =like:, and =in:) is enabled. <code>false</code> by default.</p>
@@ -427,7 +428,7 @@ <h4 class="section">Property Value</h4>
427428

428429
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.Extensions">
429430
Extensions
430-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L187"><i class="bi bi-code-slash"></i></a>
431+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L188"><i class="bi bi-code-slash"></i></a>
431432
</h3>
432433

433434
<div class="markdown level1 summary"><p>Lists the JSON:API extensions that are turned on. Empty by default, but if your project contains a controller that derives from
@@ -594,7 +595,7 @@ <h4 class="section">Property Value</h4>
594595

595596
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_MaximumIncludeDepth" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.MaximumIncludeDepth">
596597
MaximumIncludeDepth
597-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L164"><i class="bi bi-code-slash"></i></a>
598+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L165"><i class="bi bi-code-slash"></i></a>
598599
</h3>
599600

600601
<div class="markdown level1 summary"><p>Controls how many levels deep includes are allowed to be nested. For example, MaximumIncludeDepth=1 would allow ?include=articles but not
@@ -627,7 +628,7 @@ <h4 class="section">Property Value</h4>
627628

628629
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_MaximumOperationsPerRequest" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.MaximumOperationsPerRequest">
629630
MaximumOperationsPerRequest
630-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L169"><i class="bi bi-code-slash"></i></a>
631+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L170"><i class="bi bi-code-slash"></i></a>
631632
</h3>
632633

633634
<div class="markdown level1 summary"><p>Limits the maximum number of operations allowed per atomic:operations request. Defaults to 10. Set to <code>null</code> for unlimited.</p>
@@ -659,7 +660,7 @@ <h4 class="section">Property Value</h4>
659660

660661
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_MaximumPageNumber" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.MaximumPageNumber">
661662
MaximumPageNumber
662-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L120"><i class="bi bi-code-slash"></i></a>
663+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L121"><i class="bi bi-code-slash"></i></a>
663664
</h3>
664665

665666
<div class="markdown level1 summary"><p>The maximum page number that can be used, or <code>null</code> for unconstrained (default).</p>
@@ -691,7 +692,7 @@ <h4 class="section">Property Value</h4>
691692

692693
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_MaximumPageSize" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.MaximumPageSize">
693694
MaximumPageSize
694-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L115"><i class="bi bi-code-slash"></i></a>
695+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L116"><i class="bi bi-code-slash"></i></a>
695696
</h3>
696697

697698
<div class="markdown level1 summary"><p>The maximum page size that can be used, or <code>null</code> for unconstrained (default).</p>
@@ -825,7 +826,7 @@ <h4 class="section">Property Value</h4>
825826

826827
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerOptions" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.SerializerOptions">
827828
SerializerOptions
828-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L199"><i class="bi bi-code-slash"></i></a>
829+
<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>
829830
</h3>
830831

831832
<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>
@@ -862,7 +863,7 @@ <h4 class="section" id="JsonApiDotNetCore_Configuration_IJsonApiOptions_Serializ
862863

863864
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerReadOptions" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.SerializerReadOptions">
864865
SerializerReadOptions
865-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L204"><i class="bi bi-code-slash"></i></a>
866+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L205"><i class="bi bi-code-slash"></i></a>
866867
</h3>
867868

868869
<div class="markdown level1 summary"><p>Gets the settings used for deserializing request bodies. This value is based on <a class="xref" href="JsonApiDotNetCore.Configuration.IJsonApiOptions.html#JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerOptions">SerializerOptions</a> and is intended for internal use.</p>
@@ -894,7 +895,7 @@ <h4 class="section">Property Value</h4>
894895

895896
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerWriteOptions" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.SerializerWriteOptions">
896897
SerializerWriteOptions
897-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L209"><i class="bi bi-code-slash"></i></a>
898+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L210"><i class="bi bi-code-slash"></i></a>
898899
</h3>
899900

900901
<div class="markdown level1 summary"><p>Gets the settings used for serializing response bodies. This value is based on <a class="xref" href="JsonApiDotNetCore.Configuration.IJsonApiOptions.html#JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerOptions">SerializerOptions</a> and is intended for internal use.</p>
@@ -959,7 +960,7 @@ <h4 class="section">Property Value</h4>
959960

960961
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_TransactionIsolationLevel" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.TransactionIsolationLevel">
961962
TransactionIsolationLevel
962-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L175"><i class="bi bi-code-slash"></i></a>
963+
<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>
963964
</h3>
964965

965966
<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
@@ -1039,7 +1040,7 @@ <h4 class="section" id="JsonApiDotNetCore_Configuration_IJsonApiOptions_UseRelat
10391040

10401041
<h3 id="JsonApiDotNetCore_Configuration_IJsonApiOptions_ValidateModelState" data-uid="JsonApiDotNetCore.Configuration.IJsonApiOptions.ValidateModelState">
10411042
ValidateModelState
1042-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L125"><i class="bi bi-code-slash"></i></a>
1043+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/IJsonApiOptions.cs/#L126"><i class="bi bi-code-slash"></i></a>
10431044
</h3>
10441045

10451046
<div class="markdown level1 summary"><p>Whether ASP.NET ModelState validation is enabled. <code>true</code> by default.</p>

‎api/JsonApiDotNetCore.Configuration.JsonApiOptions.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,8 @@ <h3 id="JsonApiDotNetCore_Configuration_JsonApiOptions_DefaultPageSize" data-uid
431431
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs/#L62"><i class="bi bi-code-slash"></i></a>
432432
</h3>
433433

434-
<div class="markdown level1 summary"><p>The page size (10 by default) that is used when not specified in query string. Set to <code>null</code> to not use pagination by default.</p>
434+
<div class="markdown level1 summary"><p>The page size (10 by default) that is used when not specified in query string. Set to <code>null</code> to not use pagination by default. This setting can
435+
be overruled per relationship by setting <a class="xref" href="JsonApiDotNetCore.Resources.Annotations.HasManyAttribute.html#JsonApiDotNetCore_Resources_Annotations_HasManyAttribute_DisablePagination">DisablePagination</a> to <code>true</code>.</p>
435436
</div>
436437
<div class="markdown level1 conceptual"></div>
437438

0 commit comments

Comments
 (0)