Skip to content

Commit ae76f8f

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 43c1a4b 
1 parent ec9bf86 commit ae76f8f

File tree

6 files changed

+310
-1
lines changed

6 files changed

+310
-1
lines changed

‎api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Class DefaultOperationFilter </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Class DefaultOperationFilter ">
8+
9+
<meta name="description" content="Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.">
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_DefaultOperationFilter.md&amp;value=---%0Auid%3A%20JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter%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" 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.DefaultOperationFilter">
84+
85+
86+
87+
<h1 id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter" class="text-break">
88+
Class DefaultOperationFilter <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L10"><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>Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.</p>
97+
</div>
98+
<div class="markdown conceptual"></div>
99+
100+
<div class="codewrapper">
101+
<pre><code class="lang-csharp hljs">public class DefaultOperationFilter : IAtomicOperationFilter</code></pre>
102+
</div>
103+
104+
105+
106+
107+
<dl class="typelist inheritance">
108+
<dt>Inheritance</dt>
109+
<dd>
110+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
111+
<div><span class="xref">DefaultOperationFilter</span></div>
112+
</dd>
113+
</dl>
114+
115+
<dl class="typelist implements">
116+
<dt>Implements</dt>
117+
<dd>
118+
<div><a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a></div>
119+
</dd>
120+
</dl>
121+
122+
123+
<dl class="typelist inheritedMembers">
124+
<dt>Inherited Members</dt>
125+
<dd>
126+
<div>
127+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
128+
</div>
129+
<div>
130+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
131+
</div>
132+
<div>
133+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
134+
</div>
135+
<div>
136+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
137+
</div>
138+
<div>
139+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
140+
</div>
141+
<div>
142+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
143+
</div>
144+
<div>
145+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
146+
</div>
147+
</dd></dl>
148+
149+
150+
151+
152+
153+
154+
<h2 class="section" id="methods">Methods
155+
</h2>
156+
157+
158+
<a id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_GetJsonApiEndpoints_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints*"></a>
159+
160+
<h3 id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_GetJsonApiEndpoints_JsonApiDotNetCore_Configuration_ResourceType_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints(JsonApiDotNetCore.Configuration.ResourceType)">
161+
GetJsonApiEndpoints(ResourceType)
162+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L35"><i class="bi bi-code-slash"></i></a>
163+
</h3>
164+
165+
<div class="markdown level1 summary"></div>
166+
<div class="markdown level1 conceptual"></div>
167+
168+
<div class="codewrapper">
169+
<pre><code class="lang-csharp hljs">protected virtual JsonApiEndpoints? GetJsonApiEndpoints(ResourceType resourceType)</code></pre>
170+
</div>
171+
172+
<h4 class="section">Parameters</h4>
173+
<dl class="parameters">
174+
<dt><code>resourceType</code> <a class="xref" href="JsonApiDotNetCore.Configuration.ResourceType.html">ResourceType</a></dt>
175+
<dd></dd>
176+
</dl>
177+
178+
<h4 class="section">Returns</h4>
179+
<dl class="parameters">
180+
<dt><a class="xref" href="JsonApiDotNetCore.Controllers.JsonApiEndpoints.html">JsonApiEndpoints</a>?</dt>
181+
<dd></dd>
182+
</dl>
183+
184+
185+
186+
187+
188+
189+
190+
191+
192+
193+
194+
<a id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_IsEnabled_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled*"></a>
195+
196+
<h3 id="JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_IsEnabled_JsonApiDotNetCore_Configuration_ResourceType_JsonApiDotNetCore_Middleware_WriteOperationKind_" data-uid="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Middleware.WriteOperationKind)">
197+
IsEnabled(ResourceType, WriteOperationKind)
198+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L13"><i class="bi bi-code-slash"></i></a>
199+
</h3>
200+
201+
<div class="markdown level1 summary"><p>Determines whether the specified operation can be used in an atomic:operations request.</p>
202+
</div>
203+
<div class="markdown level1 conceptual"></div>
204+
205+
<div class="codewrapper">
206+
<pre><code class="lang-csharp hljs">public virtual bool IsEnabled(ResourceType resourceType, WriteOperationKind writeOperation)</code></pre>
207+
</div>
208+
209+
<h4 class="section">Parameters</h4>
210+
<dl class="parameters">
211+
<dt><code>resourceType</code> <a class="xref" href="JsonApiDotNetCore.Configuration.ResourceType.html">ResourceType</a></dt>
212+
<dd><p>The targeted primary resource type of the operation.</p>
213+
</dd>
214+
<dt><code>writeOperation</code> <a class="xref" href="JsonApiDotNetCore.Middleware.WriteOperationKind.html">WriteOperationKind</a></dt>
215+
<dd><p>The operation kind.</p>
216+
</dd>
217+
</dl>
218+
219+
<h4 class="section">Returns</h4>
220+
<dl class="parameters">
221+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
222+
<dd></dd>
223+
</dl>
224+
225+
226+
227+
228+
229+
230+
231+
232+
233+
234+
235+
236+
</article>
237+
238+
<div class="contribution d-print-none">
239+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/AtomicOperations/DefaultOperationFilter.cs/#L10" class="edit-link">Edit this page</a>
240+
</div>
241+
242+
243+
</div>
244+
245+
<div class="affix">
246+
<nav id="affix"></nav>
247+
</div>
248+
</main>
249+
250+
251+
<footer class="border-top text-secondary">
252+
<div class="container-xxl">
253+
<div class="flex-fill">
254+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
255+
</div>
256+
</div>
257+
</footer>
258+
</body>
259+
</html>

‎api/JsonApiDotNetCore.AtomicOperations.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,11 @@ <h1 id="JsonApiDotNetCore_AtomicOperations" data-uid="JsonApiDotNetCore.AtomicOp
9090
<h3 id="classes">
9191
Classes
9292
</h3>
93+
<dl class="jumplist">
94+
<dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html">DefaultOperationFilter</a></dt>
95+
<dd><p>Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.</p>
96+
</dd>
97+
</dl>
9398
<dl class="jumplist">
9499
<dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.EntityFrameworkCoreTransaction.html">EntityFrameworkCoreTransaction</a></dt>
95100
<dd><p>Represents an Entity Framework Core transaction in an atomic:operations request.</p>

‎api/toc.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
<a href="JsonApiDotNetCore.AtomicOperations.html" name="" title="JsonApiDotNetCore.AtomicOperations">JsonApiDotNetCore.AtomicOperations</a>
1818

1919
<ul class="nav level2">
20+
<li>
21+
<a href="JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html" name="" title="DefaultOperationFilter">DefaultOperationFilter</a>
22+
</li>
2023
<li>
2124
<a href="JsonApiDotNetCore.AtomicOperations.EntityFrameworkCoreTransaction.html" name="" title="EntityFrameworkCoreTransaction">EntityFrameworkCoreTransaction</a>
2225
</li>

‎api/toc.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎manifest.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22
"source_base_path": "/home/runner/work/JsonApiDotNetCore/JsonApiDotNetCore/docs",
33
"xrefmap": "xrefmap.yml",
44
"files": [
5+
{
6+
"type": "ManagedReference",
7+
"source_relative_path": "api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.yml",
8+
"output": {
9+
".html": {
10+
"relative_path": "api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html"
11+
}
12+
},
13+
"version": ""
14+
},
515
{
616
"type": "ManagedReference",
717
"source_relative_path": "api/JsonApiDotNetCore.AtomicOperations.EntityFrameworkCoreTransaction.yml",

‎xrefmap.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,38 @@ references:
77
commentId: N:JsonApiDotNetCore.AtomicOperations
88
fullName: JsonApiDotNetCore.AtomicOperations
99
nameWithType: JsonApiDotNetCore.AtomicOperations
10+
- uid: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter
11+
name: DefaultOperationFilter
12+
href: api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html
13+
commentId: T:JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter
14+
fullName: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter
15+
nameWithType: DefaultOperationFilter
16+
- uid: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints(JsonApiDotNetCore.Configuration.ResourceType)
17+
name: GetJsonApiEndpoints(ResourceType)
18+
href: api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html#JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_GetJsonApiEndpoints_JsonApiDotNetCore_Configuration_ResourceType_
19+
commentId: M:JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints(JsonApiDotNetCore.Configuration.ResourceType)
20+
fullName: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints(JsonApiDotNetCore.Configuration.ResourceType)
21+
nameWithType: DefaultOperationFilter.GetJsonApiEndpoints(ResourceType)
22+
- uid: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints*
23+
name: GetJsonApiEndpoints
24+
href: api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html#JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_GetJsonApiEndpoints_
25+
commentId: Overload:JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints
26+
isSpec: "True"
27+
fullName: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.GetJsonApiEndpoints
28+
nameWithType: DefaultOperationFilter.GetJsonApiEndpoints
29+
- uid: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Middleware.WriteOperationKind)
30+
name: IsEnabled(ResourceType, WriteOperationKind)
31+
href: api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html#JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_IsEnabled_JsonApiDotNetCore_Configuration_ResourceType_JsonApiDotNetCore_Middleware_WriteOperationKind_
32+
commentId: M:JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Middleware.WriteOperationKind)
33+
fullName: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType, JsonApiDotNetCore.Middleware.WriteOperationKind)
34+
nameWithType: DefaultOperationFilter.IsEnabled(ResourceType, WriteOperationKind)
35+
- uid: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled*
36+
name: IsEnabled
37+
href: api/JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.html#JsonApiDotNetCore_AtomicOperations_DefaultOperationFilter_IsEnabled_
38+
commentId: Overload:JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled
39+
isSpec: "True"
40+
fullName: JsonApiDotNetCore.AtomicOperations.DefaultOperationFilter.IsEnabled
41+
nameWithType: DefaultOperationFilter.IsEnabled
1042
- uid: JsonApiDotNetCore.AtomicOperations.EntityFrameworkCoreTransaction
1143
name: EntityFrameworkCoreTransaction
1244
href: api/JsonApiDotNetCore.AtomicOperations.EntityFrameworkCoreTransaction.html

0 commit comments

Comments
 (0)