Skip to content

Commit ddd7d33

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 9277256 
1 parent ac9d026 commit ddd7d33

8 files changed

+1002
-430
lines changed

‎api/JsonApiDotNetCore.Configuration.ResourceGraphBuilder.html‎

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ <h4 class="section">Returns</h4>
234234

235235
<h3 id="JsonApiDotNetCore_Configuration_ResourceGraphBuilder_Add_System_Type_System_Type_System_String_" data-uid="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.Add(System.Type,System.Type,System.String)">
236236
Add(Type, Type?, string?)
237-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs/#L205"><i class="bi bi-code-slash"></i></a>
237+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs/#L231"><i class="bi bi-code-slash"></i></a>
238238
</h3>
239239

240240
<div class="markdown level1 summary"><p>Adds a JSON:API resource.</p>
@@ -279,7 +279,7 @@ <h4 class="section">Returns</h4>
279279

280280
<h3 id="JsonApiDotNetCore_Configuration_ResourceGraphBuilder_Add__2_System_String_" data-uid="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.Add``2(System.String)">
281281
Add&lt;TResource, TId&gt;(string?)
282-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs/#L184"><i class="bi bi-code-slash"></i></a>
282+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs/#L210"><i class="bi bi-code-slash"></i></a>
283283
</h3>
284284

285285
<div class="markdown level1 summary"><p>Adds a JSON:API resource.</p>
@@ -355,6 +355,82 @@ <h4 class="section">Returns</h4>
355355

356356

357357

358+
<a id="JsonApiDotNetCore_Configuration_ResourceGraphBuilder_Remove_" data-uid="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.Remove*"></a>
359+
360+
<h3 id="JsonApiDotNetCore_Configuration_ResourceGraphBuilder_Remove_System_Type_" data-uid="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.Remove(System.Type)">
361+
Remove(Type)
362+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs/#L188"><i class="bi bi-code-slash"></i></a>
363+
</h3>
364+
365+
<div class="markdown level1 summary"><p>Removes a JSON:API resource.</p>
366+
</div>
367+
<div class="markdown level1 conceptual"></div>
368+
369+
<div class="codewrapper">
370+
<pre><code class="lang-csharp hljs">public ResourceGraphBuilder Remove(Type resourceClrType)</code></pre>
371+
</div>
372+
373+
<h4 class="section">Parameters</h4>
374+
<dl class="parameters">
375+
<dt><code>resourceClrType</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></dt>
376+
<dd><p>The resource CLR type.</p>
377+
</dd>
378+
</dl>
379+
380+
<h4 class="section">Returns</h4>
381+
<dl class="parameters">
382+
<dt><a class="xref" href="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.html">ResourceGraphBuilder</a></dt>
383+
<dd></dd>
384+
</dl>
385+
386+
387+
388+
389+
390+
391+
392+
393+
394+
395+
396+
<a id="JsonApiDotNetCore_Configuration_ResourceGraphBuilder_Remove_" data-uid="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.Remove*"></a>
397+
398+
<h3 id="JsonApiDotNetCore_Configuration_ResourceGraphBuilder_Remove__1" data-uid="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.Remove``1">
399+
Remove&lt;TResource&gt;()
400+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Configuration/ResourceGraphBuilder.cs/#L176"><i class="bi bi-code-slash"></i></a>
401+
</h3>
402+
403+
<div class="markdown level1 summary"><p>Removes a JSON:API resource.</p>
404+
</div>
405+
<div class="markdown level1 conceptual"></div>
406+
407+
<div class="codewrapper">
408+
<pre><code class="lang-csharp hljs">public ResourceGraphBuilder Remove&lt;TResource&gt;() where TResource : class, IIdentifiable</code></pre>
409+
</div>
410+
411+
412+
<h4 class="section">Returns</h4>
413+
<dl class="parameters">
414+
<dt><a class="xref" href="JsonApiDotNetCore.Configuration.ResourceGraphBuilder.html">ResourceGraphBuilder</a></dt>
415+
<dd></dd>
416+
</dl>
417+
418+
<h4 class="section">Type Parameters</h4>
419+
<dl class="parameters">
420+
<dt><code>TResource</code></dt>
421+
<dd><p>The resource CLR type.</p>
422+
</dd>
423+
</dl>
424+
425+
426+
427+
428+
429+
430+
431+
432+
433+
358434

359435
</article>
360436

‎api/JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.HideResourceIdTypeInOpenApiAttribute.html‎

Lines changed: 291 additions & 0 deletions
Large diffs are not rendered by default.

‎api/JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.html‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Namespace JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Namespace JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations ">
8+
9+
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+
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+
<script async src="https://www.googletagmanager.com/gtag/js?id=G-78GTGF1FM2"></script>
41+
<script>
42+
window.dataLayer = window.dataLayer || [];
43+
function gtag() { dataLayer.push(arguments); }
44+
gtag('js', new Date());
45+
gtag('config', 'G-78GTGF1FM2');
46+
</script>
47+
</head>
48+
49+
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
50+
<header class="bg-body border-bottom">
51+
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
52+
<div class="container-xxl flex-nowrap">
53+
<a class="navbar-brand" href="../index.html">
54+
<img id="logo" class="svg" src="../styles/img/favicon.png" alt="">
55+
56+
</a>
57+
<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">
58+
<i class="bi bi-three-dots"></i>
59+
</button>
60+
<div class="collapse navbar-collapse" id="navpanel">
61+
<div id="navbar">
62+
</div>
63+
</div>
64+
</div>
65+
</nav>
66+
</header>
67+
68+
<main class="container-xxl">
69+
<div class="toc-offcanvas">
70+
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
71+
<div class="offcanvas-header">
72+
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
73+
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
74+
</div>
75+
<div class="offcanvas-body">
76+
<nav class="toc" id="toc"></nav>
77+
</div>
78+
</div>
79+
</div>
80+
81+
<div class="content">
82+
<div class="actionbar">
83+
<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">
84+
<i class="bi bi-list"></i>
85+
</button>
86+
87+
<nav id="breadcrumb"></nav>
88+
</div>
89+
90+
<article data-uid="JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations">
91+
92+
<h1 id="JsonApiDotNetCore_OpenApi_Swashbuckle_Annotations" data-uid="JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations" class="text-break">Namespace JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations</h1>
93+
<div class="markdown level0 summary"></div>
94+
<div class="markdown level0 conceptual"></div>
95+
<div class="markdown level0 remarks"></div>
96+
97+
<h3 id="classes">
98+
Classes
99+
</h3>
100+
<dl class="jumplist">
101+
<dt><a class="xref" href="JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.HideResourceIdTypeInOpenApiAttribute.html">HideResourceIdTypeInOpenApiAttribute</a></dt>
102+
<dd><p>Hides the underlying resource ID type in OpenAPI documents.</p>
103+
</dd>
104+
</dl>
105+
106+
107+
</article>
108+
109+
<div class="contribution d-print-none">
110+
</div>
111+
112+
113+
</div>
114+
115+
<div class="affix">
116+
<nav id="affix"></nav>
117+
</div>
118+
</main>
119+
120+
121+
<footer class="border-top text-secondary">
122+
<div class="container-xxl">
123+
<div class="flex-fill">
124+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
125+
</div>
126+
</div>
127+
</footer>
128+
</body>
129+
</html>

‎api/toc.html‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,16 @@
424424
</li>
425425
</ul>
426426
</li>
427+
<li>
428+
<span class="expand-stub"></span>
429+
<a href="JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.html" name="" title="JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations">JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations</a>
430+
431+
<ul class="nav level2">
432+
<li>
433+
<a href="JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.HideResourceIdTypeInOpenApiAttribute.html" name="" title="HideResourceIdTypeInOpenApiAttribute">HideResourceIdTypeInOpenApiAttribute</a>
434+
</li>
435+
</ul>
436+
</li>
427437
<li>
428438
<span class="expand-stub"></span>
429439
<a href="JsonApiDotNetCore.Queries.html" name="" title="JsonApiDotNetCore.Queries">JsonApiDotNetCore.Queries</a>

‎api/toc.json‎

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

‎manifest.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1357,6 +1357,26 @@
13571357
},
13581358
"version": ""
13591359
},
1360+
{
1361+
"type": "ManagedReference",
1362+
"source_relative_path": "api/JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.HideResourceIdTypeInOpenApiAttribute.yml",
1363+
"output": {
1364+
".html": {
1365+
"relative_path": "api/JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.HideResourceIdTypeInOpenApiAttribute.html"
1366+
}
1367+
},
1368+
"version": ""
1369+
},
1370+
{
1371+
"type": "ManagedReference",
1372+
"source_relative_path": "api/JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.yml",
1373+
"output": {
1374+
".html": {
1375+
"relative_path": "api/JsonApiDotNetCore.OpenApi.Swashbuckle.Annotations.html"
1376+
}
1377+
},
1378+
"version": ""
1379+
},
13601380
{
13611381
"type": "ManagedReference",
13621382
"source_relative_path": "api/JsonApiDotNetCore.OpenApi.Swashbuckle.ServiceCollectionExtensions.yml",

0 commit comments

Comments
 (0)