Skip to content

Commit eccd22d

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 4e0f2a7 
1 parent f91d8f8 commit eccd22d

9 files changed

+376
-33
lines changed

‎api/JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html‎

Lines changed: 227 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,227 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Interface IAtomicOperationFilter </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Interface IAtomicOperationFilter ">
8+
9+
<meta name="description" content="Determines whether an operation in an atomic:operations request can be used.">
10+
<link rel="icon" href="../favicon.ico">
11+
<link rel="stylesheet" href="../public/docfx.min.css">
12+
<link rel="stylesheet" href="../public/main.css">
13+
<meta name="docfx:navrel" content="../toc.html">
14+
<meta name="docfx:tocrel" content="toc.html">
15+
16+
17+
18+
19+
<meta name="docfx:docurl" content="https://github.com/json-api-dotnet/JsonApiDotNetCore/new/master/apiSpec/new?filename=JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter.md&amp;value=---%0Auid%3A%20JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
20+
<meta name="loc:inThisArticle" content="In this article">
21+
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
22+
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
23+
<meta name="loc:tocFilter" content="Filter by title">
24+
<meta name="loc:nextArticle" content="Next">
25+
<meta name="loc:prevArticle" content="Previous">
26+
<meta name="loc:themeLight" content="Light">
27+
<meta name="loc:themeDark" content="Dark">
28+
<meta name="loc:themeAuto" content="Auto">
29+
<meta name="loc:changeTheme" content="Change theme">
30+
<meta name="loc:copy" content="Copy">
31+
<meta name="loc:downloadPdf" content="Download PDF">
32+
33+
<script type="module" src="./../public/docfx.min.js"></script>
34+
35+
<script>
36+
const theme = localStorage.getItem('theme') || 'auto'
37+
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
38+
</script>
39+
40+
</head>
41+
42+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
43+
<header class="bg-body border-bottom">
44+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
45+
<div class="container-xxl flex-nowrap">
46+
<a class="navbar-brand" href="../index.html">
47+
<img id="logo" class="svg" src="../logo.svg" alt="">
48+
49+
</a>
50+
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
51+
<i class="bi bi-three-dots"></i>
52+
</button>
53+
<div class="collapse navbar-collapse" id="navpanel">
54+
<div id="navbar">
55+
</div>
56+
</div>
57+
</div>
58+
</nav>
59+
</header>
60+
61+
<main class="container-xxl">
62+
<div class="toc-offcanvas">
63+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
64+
<div class="offcanvas-header">
65+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
66+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
67+
</div>
68+
<div class="offcanvas-body">
69+
<nav class="toc" id="toc"></nav>
70+
</div>
71+
</div>
72+
</div>
73+
74+
<div class="content">
75+
<div class="actionbar">
76+
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
77+
<i class="bi bi-list"></i>
78+
</button>
79+
80+
<nav id="breadcrumb"></nav>
81+
</div>
82+
83+
<article data-uid="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter">
84+
85+
86+
87+
<h1 id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter" data-uid="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter" class="text-break">
88+
Interface IAtomicOperationFilter <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/IAtomicOperationFilter.cs/#L15"><i class="bi bi-code-slash"></i></a>
89+
</h1>
90+
91+
<div class="facts text-secondary">
92+
<dl><dt>Namespace</dt><dd><a class="xref" href="JsonApiDotNetCore.html">JsonApiDotNetCore</a>.<a class="xref" href="JsonApiDotNetCore.AtomicOperations.html">AtomicOperations</a></dd></dl>
93+
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
94+
</div>
95+
96+
<div class="markdown summary"><p>Determines whether an operation in an atomic:operations request can be used.</p>
97+
</div>
98+
<div class="markdown conceptual"></div>
99+
100+
<div class="codewrapper">
101+
<pre><code class="lang-csharp hljs">[PublicAPI]
102+
public interface IAtomicOperationFilter</code></pre>
103+
</div>
104+
105+
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+
<h2 id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter_remarks">Remarks</h2>
116+
<div class="markdown level0 remarks"><p>The default implementation relies on the usage of <a class="xref" href="JsonApiDotNetCore.Resources.Annotations.ResourceAttribute.html#JsonApiDotNetCore_Resources_Annotations_ResourceAttribute_GenerateControllerEndpoints">GenerateControllerEndpoints</a>. If you're using explicit
117+
(non-generated) controllers, register your own implementation to indicate which operations are accessible.</p>
118+
</div>
119+
120+
121+
<h2 class="section" id="properties">Properties
122+
</h2>
123+
124+
125+
<a id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter_AlwaysEnabled_" data-uid="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.AlwaysEnabled*"></a>
126+
127+
<h3 id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter_AlwaysEnabled" data-uid="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.AlwaysEnabled">
128+
AlwaysEnabled
129+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/IAtomicOperationFilter.cs/#L22"><i class="bi bi-code-slash"></i></a>
130+
</h3>
131+
132+
<div class="markdown level1 summary"><p>An <a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a> that always returns <code>true</code>. Provided for convenience, to revert to the original behavior from before
133+
filtering was introduced.</p>
134+
</div>
135+
<div class="markdown level1 conceptual"></div>
136+
137+
<div class="codewrapper">
138+
<pre><code class="lang-csharp hljs">public static IAtomicOperationFilter AlwaysEnabled { get; }</code></pre>
139+
</div>
140+
141+
142+
143+
144+
145+
<h4 class="section">Property Value</h4>
146+
<dl class="parameters">
147+
<dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a></dt>
148+
<dd></dd>
149+
</dl>
150+
151+
152+
153+
154+
155+
156+
157+
158+
<h2 class="section" id="methods">Methods
159+
</h2>
160+
161+
162+
<a id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter_IsEnabled_" data-uid="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.IsEnabled*"></a>
163+
164+
<h3 id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter_IsEnabled_JsonApiDotNetCore_Configuration_ResourceType_JsonApiDotNetCore_Middleware_WriteOperationKind_" data-uid="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Middleware.WriteOperationKind)">
165+
IsEnabled(ResourceType, WriteOperationKind)
166+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/IAtomicOperationFilter.cs/#L33"><i class="bi bi-code-slash"></i></a>
167+
</h3>
168+
169+
<div class="markdown level1 summary"><p>Determines whether the specified operation can be used in an atomic:operations request.</p>
170+
</div>
171+
<div class="markdown level1 conceptual"></div>
172+
173+
<div class="codewrapper">
174+
<pre><code class="lang-csharp hljs">bool IsEnabled(ResourceType resourceType, WriteOperationKind writeOperation)</code></pre>
175+
</div>
176+
177+
<h4 class="section">Parameters</h4>
178+
<dl class="parameters">
179+
<dt><code>resourceType</code> <a class="xref" href="JsonApiDotNetCore.Configuration.ResourceType.html">ResourceType</a></dt>
180+
<dd><p>The targeted primary resource type of the operation.</p>
181+
</dd>
182+
<dt><code>writeOperation</code> <a class="xref" href="JsonApiDotNetCore.Middleware.WriteOperationKind.html">WriteOperationKind</a></dt>
183+
<dd><p>The operation kind.</p>
184+
</dd>
185+
</dl>
186+
187+
<h4 class="section">Returns</h4>
188+
<dl class="parameters">
189+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
190+
<dd></dd>
191+
</dl>
192+
193+
194+
195+
196+
197+
198+
199+
200+
201+
202+
203+
204+
</article>
205+
206+
<div class="contribution d-print-none">
207+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/IAtomicOperationFilter.cs/#L15" class="edit-link">Edit this page</a>
208+
</div>
209+
210+
211+
</div>
212+
213+
<div class="affix">
214+
<nav id="affix"></nav>
215+
</div>
216+
</main>
217+
218+
219+
<footer class="border-top text-secondary">
220+
<div class="container-xxl">
221+
<div class="flex-fill">
222+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
223+
</div>
224+
</div>
225+
</footer>
226+
</body>
227+
</html>

‎api/JsonApiDotNetCore.AtomicOperations.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,11 @@ <h3 id="classes">
128128
<h3 id="interfaces">
129129
Interfaces
130130
</h3>
131+
<dl class="jumplist">
132+
<dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a></dt>
133+
<dd><p>Determines whether an operation in an atomic:operations request can be used.</p>
134+
</dd>
135+
</dl>
131136
<dl class="jumplist">
132137
<dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.ILocalIdTracker.html">ILocalIdTracker</a></dt>
133138
<dd><p>Used to track declarations, assignments and references to local IDs an in atomic:operations request.</p>

‎api/JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.html‎

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

8686

8787
<h1 id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController" class="text-break">
88-
Class BaseJsonApiOperationsController <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L17"><i class="bi bi-code-slash"></i></a>
88+
Class BaseJsonApiOperationsController <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L19"><i class="bi bi-code-slash"></i></a>
8989
</h1>
9090

9191
<div class="facts text-secondary">
@@ -686,16 +686,16 @@ <h2 class="section" id="constructors">Constructors
686686

687687
<a id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController__ctor_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.#ctor*"></a>
688688

689-
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_JsonApiDotNetCore_Configuration_IResourceGraph_Microsoft_Extensions_Logging_ILoggerFactory_JsonApiDotNetCore_AtomicOperations_IOperationsProcessor_JsonApiDotNetCore_Middleware_IJsonApiRequest_JsonApiDotNetCore_Resources_ITargetedFields_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,JsonApiDotNetCore.Configuration.IResourceGraph,Microsoft.Extensions.Logging.ILoggerFactory,JsonApiDotNetCore.AtomicOperations.IOperationsProcessor,JsonApiDotNetCore.Middleware.IJsonApiRequest,JsonApiDotNetCore.Resources.ITargetedFields)">
690-
BaseJsonApiOperationsController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IOperationsProcessor, IJsonApiRequest, ITargetedFields)
691-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L27"><i class="bi bi-code-slash"></i></a>
689+
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController__ctor_JsonApiDotNetCore_Configuration_IJsonApiOptions_JsonApiDotNetCore_Configuration_IResourceGraph_Microsoft_Extensions_Logging_ILoggerFactory_JsonApiDotNetCore_AtomicOperations_IOperationsProcessor_JsonApiDotNetCore_Middleware_IJsonApiRequest_JsonApiDotNetCore_Resources_ITargetedFields_JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.#ctor(JsonApiDotNetCore.Configuration.IJsonApiOptions,JsonApiDotNetCore.Configuration.IResourceGraph,Microsoft.Extensions.Logging.ILoggerFactory,JsonApiDotNetCore.AtomicOperations.IOperationsProcessor,JsonApiDotNetCore.Middleware.IJsonApiRequest,JsonApiDotNetCore.Resources.ITargetedFields,JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter)">
690+
BaseJsonApiOperationsController(IJsonApiOptions, IResourceGraph, ILoggerFactory, IOperationsProcessor, IJsonApiRequest, ITargetedFields, IAtomicOperationFilter)
691+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L30"><i class="bi bi-code-slash"></i></a>
692692
</h3>
693693

694694
<div class="markdown level1 summary"></div>
695695
<div class="markdown level1 conceptual"></div>
696696

697697
<div class="codewrapper">
698-
<pre><code class="lang-csharp hljs">protected BaseJsonApiOperationsController(IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IOperationsProcessor processor, IJsonApiRequest request, ITargetedFields targetedFields)</code></pre>
698+
<pre><code class="lang-csharp hljs">protected BaseJsonApiOperationsController(IJsonApiOptions options, IResourceGraph resourceGraph, ILoggerFactory loggerFactory, IOperationsProcessor processor, IJsonApiRequest request, ITargetedFields targetedFields, IAtomicOperationFilter operationFilter)</code></pre>
699699
</div>
700700

701701
<h4 class="section">Parameters</h4>
@@ -712,6 +712,8 @@ <h4 class="section">Parameters</h4>
712712
<dd></dd>
713713
<dt><code>targetedFields</code> <a class="xref" href="JsonApiDotNetCore.Resources.ITargetedFields.html">ITargetedFields</a></dt>
714714
<dd></dd>
715+
<dt><code>operationFilter</code> <a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a></dt>
716+
<dd></dd>
715717
</dl>
716718

717719

@@ -733,7 +735,7 @@ <h2 class="section" id="methods">Methods
733735

734736
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController_PostOperationsAsync_System_Collections_Generic_IList_JsonApiDotNetCore_Resources_OperationContainer__System_Threading_CancellationToken_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.PostOperationsAsync(System.Collections.Generic.IList{JsonApiDotNetCore.Resources.OperationContainer},System.Threading.CancellationToken)">
735737
PostOperationsAsync(IList&lt;OperationContainer&gt;, CancellationToken)
736-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L105"><i class="bi bi-code-slash"></i></a>
738+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L110"><i class="bi bi-code-slash"></i></a>
737739
</h3>
738740

739741
<div class="markdown level1 summary"><p>Atomically processes a list of operations and returns a list of results. All changes are reverted if processing fails. If processing succeeds but
@@ -817,11 +819,42 @@ <h4 class="section" id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsContr
817819

818820

819821

822+
<a id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController_ValidateEnabledOperations_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.ValidateEnabledOperations*"></a>
823+
824+
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController_ValidateEnabledOperations_System_Collections_Generic_IList_JsonApiDotNetCore_Resources_OperationContainer__" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.ValidateEnabledOperations(System.Collections.Generic.IList{JsonApiDotNetCore.Resources.OperationContainer})">
825+
ValidateEnabledOperations(IList&lt;OperationContainer&gt;)
826+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L130"><i class="bi bi-code-slash"></i></a>
827+
</h3>
828+
829+
<div class="markdown level1 summary"></div>
830+
<div class="markdown level1 conceptual"></div>
831+
832+
<div class="codewrapper">
833+
<pre><code class="lang-csharp hljs">protected virtual void ValidateEnabledOperations(IList&lt;OperationContainer&gt; operations)</code></pre>
834+
</div>
835+
836+
<h4 class="section">Parameters</h4>
837+
<dl class="parameters">
838+
<dt><code>operations</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1">IList</a>&lt;<a class="xref" href="JsonApiDotNetCore.Resources.OperationContainer.html">OperationContainer</a>&gt;</dt>
839+
<dd></dd>
840+
</dl>
841+
842+
843+
844+
845+
846+
847+
848+
849+
850+
851+
852+
820853
<a id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController_ValidateModelState_" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.ValidateModelState*"></a>
821854

822855
<h3 id="JsonApiDotNetCore_Controllers_BaseJsonApiOperationsController_ValidateModelState_System_Collections_Generic_IList_JsonApiDotNetCore_Resources_OperationContainer__" data-uid="JsonApiDotNetCore.Controllers.BaseJsonApiOperationsController.ValidateModelState(System.Collections.Generic.IList{JsonApiDotNetCore.Resources.OperationContainer})">
823856
ValidateModelState(IList&lt;OperationContainer&gt;)
824-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L123"><i class="bi bi-code-slash"></i></a>
857+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L192"><i class="bi bi-code-slash"></i></a>
825858
</h3>
826859

827860
<div class="markdown level1 summary"></div>
@@ -852,7 +885,7 @@ <h4 class="section">Parameters</h4>
852885
</article>
853886

854887
<div class="contribution d-print-none">
855-
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L17" class="edit-link">Edit this page</a>
888+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Controllers/BaseJsonApiOperationsController.cs/#L19" class="edit-link">Edit this page</a>
856889
</div>
857890

858891

0 commit comments

Comments
 (0)