Skip to content

Commit 7253cb6

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from ae82a95 
1 parent a0d9f26 commit 7253cb6

15 files changed

Lines changed: 597 additions & 540 deletions

‎api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -850,7 +850,7 @@ <h4 class="section">Property Value</h4>
850850

851851

852852
<h4 class="section" id="JsonApiDotNetCore_Configuration_IJsonApiOptions_SerializerOptions_examples">Examples</h4>
853-
<p>The next example sets the naming convention to camel casing.</p>
853+
<p>The following example sets the naming convention to camel casing.</p>
854854
<pre><code class="lang-csharp">options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
855855
options.SerializerOptions.DictionaryKeyPolicy = JsonNamingPolicy.CamelCase;</code></pre>
856856

‎api/JsonApiDotNetCore.Configuration.JsonApiOptions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -915,7 +915,7 @@ <h4 class="section">Property Value</h4>
915915

916916

917917
<h4 class="section" id="JsonApiDotNetCore_Configuration_JsonApiOptions_SerializerOptions_examples">Examples</h4>
918-
<p>The next example sets the naming convention to camel casing.</p>
918+
<p>The following example sets the naming convention to camel casing.</p>
919919
<pre><code class="lang-csharp">options.SerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
920920
options.SerializerOptions.DictionaryKeyPolicy = JsonNamingPolicy.CamelCase;</code></pre>
921921

‎api/JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute.html‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
9292

9393

9494
<h1 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute" class="text-break">
95-
Class DisableQueryStringAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L17"><i class="bi bi-code-slash"></i></a>
95+
Class DisableQueryStringAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L19"><i class="bi bi-code-slash"></i></a>
9696
</h1>
9797

9898
<div class="facts text-secondary">
@@ -255,11 +255,10 @@ <h1 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute" d
255255

256256

257257
<h2 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute_examples">Examples</h2>
258-
<p>[DisableQueryString(JsonApiQueryStringParameters.Sort | JsonApiQueryStringParameters.Page)]
259-
public class CustomersController : JsonApiController&lt;Customer&gt; { }</p>
260-
261-
<p>[DisableQueryString(&quot;skipCache&quot;)]
262-
public class CustomersController : JsonApiController&lt;Customer&gt; { }</p>
258+
<pre><code class="lang-csharp">[DisableQueryString(JsonApiQueryStringParameters.Sort | JsonApiQueryStringParameters.Page)]
259+
public class CustomersController : JsonApiController&lt;Customer&gt; { }</code></pre>
260+
<pre><code class="lang-csharp">[DisableQueryString("skipCache")]
261+
public class CustomersController : JsonApiController&lt;Customer&gt; { }</code></pre>
263262

264263

265264

@@ -272,7 +271,7 @@ <h2 class="section" id="constructors">Constructors
272271

273272
<h3 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute__ctor_JsonApiDotNetCore_QueryStrings_JsonApiQueryStringParameters_" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute.#ctor(JsonApiDotNetCore.QueryStrings.JsonApiQueryStringParameters)">
274273
DisableQueryStringAttribute(JsonApiQueryStringParameters)
275-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L28"><i class="bi bi-code-slash"></i></a>
274+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L30"><i class="bi bi-code-slash"></i></a>
276275
</h3>
277276

278277
<div class="markdown level1 summary"><p>Disables one or more of the builtin query parameters for a controller.</p>
@@ -304,7 +303,7 @@ <h4 class="section">Parameters</h4>
304303

305304
<h3 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute__ctor_System_String_" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute.#ctor(System.String)">
306305
DisableQueryStringAttribute(string)
307-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L47"><i class="bi bi-code-slash"></i></a>
306+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L49"><i class="bi bi-code-slash"></i></a>
308307
</h3>
309308

310309
<div class="markdown level1 summary"><p>It is allowed to use a comma-separated list of strings to indicate which query parameters should be disabled, because the user may have defined
@@ -340,7 +339,7 @@ <h2 class="section" id="fields">Fields
340339

341340
<h3 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute_Empty" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute.Empty">
342341
Empty
343-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L21"><i class="bi bi-code-slash"></i></a>
342+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L23"><i class="bi bi-code-slash"></i></a>
344343
</h3>
345344

346345
<div class="markdown level1 summary"></div>
@@ -375,7 +374,7 @@ <h2 class="section" id="properties">Properties
375374

376375
<h3 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute_ParameterNames" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute.ParameterNames">
377376
ParameterNames
378-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L23"><i class="bi bi-code-slash"></i></a>
377+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L25"><i class="bi bi-code-slash"></i></a>
379378
</h3>
380379

381380
<div class="markdown level1 summary"></div>
@@ -410,7 +409,7 @@ <h2 class="section" id="methods">Methods
410409

411410
<h3 id="JsonApiDotNetCore_Controllers_Annotations_DisableQueryStringAttribute_ContainsParameter_JsonApiDotNetCore_QueryStrings_JsonApiQueryStringParameters_" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableQueryStringAttribute.ContainsParameter(JsonApiDotNetCore.QueryStrings.JsonApiQueryStringParameters)">
412411
ContainsParameter(JsonApiQueryStringParameters)
413-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L54"><i class="bi bi-code-slash"></i></a>
412+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L56"><i class="bi bi-code-slash"></i></a>
414413
</h3>
415414

416415
<div class="markdown level1 summary"></div>
@@ -446,7 +445,7 @@ <h4 class="section">Returns</h4>
446445
</article>
447446

448447
<div class="contribution d-print-none">
449-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L17" class="edit-link">Edit this page</a>
448+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableQueryStringAttribute.cs/#L19" class="edit-link">Edit this page</a>
450449
</div>
451450

452451

‎api/JsonApiDotNetCore.Controllers.Annotations.DisableRoutingConventionAttribute.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
9292

9393

9494
<h1 id="JsonApiDotNetCore_Controllers_Annotations_DisableRoutingConventionAttribute" data-uid="JsonApiDotNetCore.Controllers.Annotations.DisableRoutingConventionAttribute" class="text-break">
95-
Class DisableRoutingConventionAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableRoutingConventionAttribute.cs/#L12"><i class="bi bi-code-slash"></i></a>
95+
Class DisableRoutingConventionAttribute <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableRoutingConventionAttribute.cs/#L14"><i class="bi bi-code-slash"></i></a>
9696
</h1>
9797

9898
<div class="facts text-secondary">
@@ -255,8 +255,8 @@ <h1 id="JsonApiDotNetCore_Controllers_Annotations_DisableRoutingConventionAttrib
255255

256256

257257
<h2 id="JsonApiDotNetCore_Controllers_Annotations_DisableRoutingConventionAttribute_examples">Examples</h2>
258-
<p>[DisableRoutingConvention, Route(&quot;some/custom/route/to/customers&quot;)]
259-
public class CustomersController : JsonApiController&lt;Customer&gt; { }</p>
258+
<pre><code class="lang-csharp">[DisableRoutingConvention, Route("some/custom/route/to/customers")]
259+
public class CustomersController : JsonApiController&lt;Customer&gt; { }</code></pre>
260260

261261

262262

@@ -265,7 +265,7 @@ <h2 id="JsonApiDotNetCore_Controllers_Annotations_DisableRoutingConventionAttrib
265265
</article>
266266

267267
<div class="contribution d-print-none">
268-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableRoutingConventionAttribute.cs/#L12" class="edit-link">Edit this page</a>
268+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/Annotations/DisableRoutingConventionAttribute.cs/#L14" class="edit-link">Edit this page</a>
269269
</div>
270270

271271

0 commit comments

Comments
 (0)