Skip to content

Commit 1980948

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from c4dde57 
1 parent 362e6e6 commit 1980948

10 files changed

+259
-33
lines changed

‎api/JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.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 IAtomicOperationFilter ">
88

9-
<meta name="description" content="Determines whether an operation in an atomic:operations request can be used.">
9+
<meta name="description" content="Determines whether an operation in an atomic:operations request can be used. For non-operations 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">
@@ -93,7 +93,7 @@ <h1 id="JsonApiDotNetCore_AtomicOperations_IAtomicOperationFilter" data-uid="Jso
9393
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
9494
</div>
9595

96-
<div class="markdown summary"><p>Determines whether an operation in an atomic:operations request can be used.</p>
96+
<div class="markdown summary"><p>Determines whether an operation in an atomic:operations request can be used. For non-operations requests, see <a class="xref" href="JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.html">IJsonApiEndpointFilter</a>.</p>
9797
</div>
9898
<div class="markdown conceptual"></div>
9999

‎api/JsonApiDotNetCore.AtomicOperations.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ <h3 id="interfaces">
135135
</h3>
136136
<dl class="jumplist">
137137
<dt><a class="xref" href="JsonApiDotNetCore.AtomicOperations.IAtomicOperationFilter.html">IAtomicOperationFilter</a></dt>
138-
<dd><p>Determines whether an operation in an atomic:operations request can be used.</p>
138+
<dd><p>Determines whether an operation in an atomic:operations request can be used. For non-operations requests, see <a class="xref" href="JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.html">IJsonApiEndpointFilter</a>.</p>
139139
</dd>
140140
</dl>
141141
<dl class="jumplist">

‎api/JsonApiDotNetCore.Configuration.ResourceType.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -861,7 +861,7 @@ <h3 id="JsonApiDotNetCore_Configuration_ResourceType_GetAllConcreteDerivedTypes"
861861
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore.Annotations/Configuration/ResourceType.cs/#L222"><i class="bi bi-code-slash"></i></a>
862862
</h3>
863863

864-
<div class="markdown level1 summary"><p>Returns all directly and indirectly non-abstract resource types that derive from this resource type.</p>
864+
<div class="markdown level1 summary"><p>Returns all non-abstract resource types that directly or indirectly derive from this resource type.</p>
865865
</div>
866866
<div class="markdown level1 conceptual"></div>
867867

‎api/JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.html

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,186 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Interface IJsonApiEndpointFilter </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Interface IJsonApiEndpointFilter ">
8+
9+
<meta name="description" content="Enables to remove JSON:API controller action methods at startup. For atomic:operation requests, see .">
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_Middleware_IJsonApiEndpointFilter.md&amp;value=---%0Auid%3A%20JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter%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.Middleware.IJsonApiEndpointFilter">
84+
85+
86+
87+
<h1 id="JsonApiDotNetCore_Middleware_IJsonApiEndpointFilter" data-uid="JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter" class="text-break">
88+
Interface IJsonApiEndpointFilter <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiEndpointFilter.cs/#L11"><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.Middleware.html">Middleware</a></dd></dl>
93+
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
94+
</div>
95+
96+
<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>
97+
</div>
98+
<div class="markdown conceptual"></div>
99+
100+
<div class="codewrapper">
101+
<pre><code class="lang-csharp hljs">[PublicAPI]
102+
public interface IJsonApiEndpointFilter</code></pre>
103+
</div>
104+
105+
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+
116+
117+
<h2 class="section" id="methods">Methods
118+
</h2>
119+
120+
121+
<a id="JsonApiDotNetCore_Middleware_IJsonApiEndpointFilter_IsEnabled_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.IsEnabled*"></a>
122+
123+
<h3 id="JsonApiDotNetCore_Middleware_IJsonApiEndpointFilter_IsEnabled_JsonApiDotNetCore_Configuration_ResourceType_JsonApiDotNetCore_Controllers_JsonApiEndpoints_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiEndpointFilter.IsEnabled(JsonApiDotNetCore.Configuration.ResourceType,JsonApiDotNetCore.Controllers.JsonApiEndpoints)">
124+
IsEnabled(ResourceType, JsonApiEndpoints)
125+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiEndpointFilter.cs/#L23"><i class="bi bi-code-slash"></i></a>
126+
</h3>
127+
128+
<div class="markdown level1 summary"><p>Determines whether to remove the associated controller action method.</p>
129+
</div>
130+
<div class="markdown level1 conceptual"></div>
131+
132+
<div class="codewrapper">
133+
<pre><code class="lang-csharp hljs">bool IsEnabled(ResourceType resourceType, JsonApiEndpoints endpoint)</code></pre>
134+
</div>
135+
136+
<h4 class="section">Parameters</h4>
137+
<dl class="parameters">
138+
<dt><code>resourceType</code> <a class="xref" href="JsonApiDotNetCore.Configuration.ResourceType.html">ResourceType</a></dt>
139+
<dd><p>The primary resource type of the endpoint.</p>
140+
</dd>
141+
<dt><code>endpoint</code> <a class="xref" href="JsonApiDotNetCore.Controllers.JsonApiEndpoints.html">JsonApiEndpoints</a></dt>
142+
<dd><p>The JSON:API endpoint. Despite <a class="xref" href="JsonApiDotNetCore.Controllers.JsonApiEndpoints.html">JsonApiEndpoints</a> being a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.flagsattribute">FlagsAttribute</a> enum, a single value is always passed here.</p>
143+
</dd>
144+
</dl>
145+
146+
<h4 class="section">Returns</h4>
147+
<dl class="parameters">
148+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
149+
<dd></dd>
150+
</dl>
151+
152+
153+
154+
155+
156+
157+
158+
159+
160+
161+
162+
163+
</article>
164+
165+
<div class="contribution d-print-none">
166+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiEndpointFilter.cs/#L11" class="edit-link">Edit this page</a>
167+
</div>
168+
169+
170+
</div>
171+
172+
<div class="affix">
173+
<nav id="affix"></nav>
174+
</div>
175+
</main>
176+
177+
178+
<footer class="border-top text-secondary">
179+
<div class="container-xxl">
180+
<div class="flex-fill">
181+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
182+
</div>
183+
</div>
184+
</footer>
185+
</body>
186+
</html>

0 commit comments

Comments
 (0)