Skip to content

Commit ec9bf86

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 8ff2900 
1 parent f7463d5 commit ec9bf86

16 files changed

+2173
-91
lines changed

‎api/JsonApiDotNetCore.Configuration.IJsonApiOptions.html‎

Lines changed: 68 additions & 29 deletions
Large diffs are not rendered by default.

‎api/JsonApiDotNetCore.Configuration.JsonApiOptions.html‎

Lines changed: 104 additions & 28 deletions
Large diffs are not rendered by default.

‎api/JsonApiDotNetCore.Middleware.HeaderConstants.html‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -152,14 +152,15 @@ <h2 class="section" id="fields">Fields
152152

153153
<h3 id="JsonApiDotNetCore_Middleware_HeaderConstants_AtomicOperationsMediaType" data-uid="JsonApiDotNetCore.Middleware.HeaderConstants.AtomicOperationsMediaType">
154154
AtomicOperationsMediaType
155-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/HeaderConstants.cs/#L11"><i class="bi bi-code-slash"></i></a>
155+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/HeaderConstants.cs/#L14"><i class="bi bi-code-slash"></i></a>
156156
</h3>
157157

158158
<div class="markdown level1 summary"></div>
159159
<div class="markdown level1 conceptual"></div>
160160

161161
<div class="codewrapper">
162-
<pre><code class="lang-csharp hljs">public const string AtomicOperationsMediaType = &quot;application/vnd.api+json; ext=\&quot;https://jsonapi.org/ext/atomic\&quot;&quot;</code></pre>
162+
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use JsonApiMediaType.AtomicOperations.ToString() instead.&quot;)]
163+
public const string AtomicOperationsMediaType = &quot;application/vnd.api+json; ext=\&quot;https://jsonapi.org/ext/atomic\&quot;&quot;</code></pre>
163164
</div>
164165

165166

@@ -182,14 +183,15 @@ <h4 class="section">Field Value</h4>
182183

183184
<h3 id="JsonApiDotNetCore_Middleware_HeaderConstants_MediaType" data-uid="JsonApiDotNetCore.Middleware.HeaderConstants.MediaType">
184185
MediaType
185-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/HeaderConstants.cs/#L10"><i class="bi bi-code-slash"></i></a>
186+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/HeaderConstants.cs/#L11"><i class="bi bi-code-slash"></i></a>
186187
</h3>
187188

188189
<div class="markdown level1 summary"></div>
189190
<div class="markdown level1 conceptual"></div>
190191

191192
<div class="codewrapper">
192-
<pre><code class="lang-csharp hljs">public const string MediaType = &quot;application/vnd.api+json&quot;</code></pre>
193+
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use JsonApiMediaType.Default.ToString() instead.&quot;)]
194+
public const string MediaType = &quot;application/vnd.api+json&quot;</code></pre>
193195
</div>
194196

195197

@@ -212,14 +214,15 @@ <h4 class="section">Field Value</h4>
212214

213215
<h3 id="JsonApiDotNetCore_Middleware_HeaderConstants_RelaxedAtomicOperationsMediaType" data-uid="JsonApiDotNetCore.Middleware.HeaderConstants.RelaxedAtomicOperationsMediaType">
214216
RelaxedAtomicOperationsMediaType
215-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/HeaderConstants.cs/#L12"><i class="bi bi-code-slash"></i></a>
217+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/HeaderConstants.cs/#L17"><i class="bi bi-code-slash"></i></a>
216218
</h3>
217219

218220
<div class="markdown level1 summary"></div>
219221
<div class="markdown level1 conceptual"></div>
220222

221223
<div class="codewrapper">
222-
<pre><code class="lang-csharp hljs">public const string RelaxedAtomicOperationsMediaType = &quot;application/vnd.api+json; ext=atomic-operations&quot;</code></pre>
224+
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use JsonApiMediaType.RelaxedAtomicOperations.ToString() instead.&quot;)]
225+
public const string RelaxedAtomicOperationsMediaType = &quot;application/vnd.api+json; ext=atomic-operations&quot;</code></pre>
223226
</div>
224227

225228

‎api/JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.html‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Interface IJsonApiContentNegotiator </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Interface IJsonApiContentNegotiator ">
8+
9+
<meta name="description" content="Performs content negotiation for JSON:API requests.">
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_IJsonApiContentNegotiator.md&amp;value=---%0Auid%3A%20JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator%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.IJsonApiContentNegotiator">
84+
85+
86+
87+
<h1 id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator" data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator" class="text-break">
88+
Interface IJsonApiContentNegotiator <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiContentNegotiator.cs/#L9"><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>Performs content negotiation for JSON:API requests.</p>
97+
</div>
98+
<div class="markdown conceptual"></div>
99+
100+
<div class="codewrapper">
101+
<pre><code class="lang-csharp hljs">public interface IJsonApiContentNegotiator</code></pre>
102+
</div>
103+
104+
105+
106+
107+
108+
109+
110+
111+
112+
113+
114+
115+
116+
<h2 class="section" id="methods">Methods
117+
</h2>
118+
119+
120+
<a id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator_Negotiate_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.Negotiate*"></a>
121+
122+
<h3 id="JsonApiDotNetCore_Middleware_IJsonApiContentNegotiator_Negotiate" data-uid="JsonApiDotNetCore.Middleware.IJsonApiContentNegotiator.Negotiate">
123+
Negotiate()
124+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiContentNegotiator.cs/#L15"><i class="bi bi-code-slash"></i></a>
125+
</h3>
126+
127+
<div class="markdown level1 summary"><p>Validates the Content-Type and Accept HTTP headers from the incoming request. Throws a <a class="xref" href="JsonApiDotNetCore.Errors.JsonApiException.html">JsonApiException</a> if unsupported. Otherwise,
128+
returns the list of negotiated JSON:API extensions, which should always be a subset of <a class="xref" href="JsonApiDotNetCore.Configuration.IJsonApiOptions.html#JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions">Extensions</a>.</p>
129+
</div>
130+
<div class="markdown level1 conceptual"></div>
131+
132+
<div class="codewrapper">
133+
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Negotiate()</code></pre>
134+
</div>
135+
136+
137+
<h4 class="section">Returns</h4>
138+
<dl class="parameters">
139+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
140+
<dd></dd>
141+
</dl>
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
152+
153+
154+
</article>
155+
156+
<div class="contribution d-print-none">
157+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiContentNegotiator.cs/#L9" class="edit-link">Edit this page</a>
158+
</div>
159+
160+
161+
</div>
162+
163+
<div class="affix">
164+
<nav id="affix"></nav>
165+
</div>
166+
</main>
167+
168+
169+
<footer class="border-top text-secondary">
170+
<div class="container-xxl">
171+
<div class="flex-fill">
172+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
173+
</div>
174+
</div>
175+
</footer>
176+
</body>
177+
</html>

‎api/JsonApiDotNetCore.Middleware.IJsonApiRequest.html‎

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,38 @@ <h2 class="section" id="properties">Properties
117117
</h2>
118118

119119

120+
<a id="JsonApiDotNetCore_Middleware_IJsonApiRequest_Extensions_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiRequest.Extensions*"></a>
121+
122+
<h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_Extensions" data-uid="JsonApiDotNetCore.Middleware.IJsonApiRequest.Extensions">
123+
Extensions
124+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiRequest.cs/#L66"><i class="bi bi-code-slash"></i></a>
125+
</h3>
126+
127+
<div class="markdown level1 summary"><p>The JSON:API extensions enabled for the current request. This is always a subset of <a class="xref" href="JsonApiDotNetCore.Configuration.IJsonApiOptions.html#JsonApiDotNetCore_Configuration_IJsonApiOptions_Extensions">Extensions</a>.</p>
128+
</div>
129+
<div class="markdown level1 conceptual"></div>
130+
131+
<div class="codewrapper">
132+
<pre><code class="lang-csharp hljs">IReadOnlySet&lt;JsonApiExtension&gt; Extensions { get; }</code></pre>
133+
</div>
134+
135+
136+
137+
138+
139+
<h4 class="section">Property Value</h4>
140+
<dl class="parameters">
141+
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlyset-1">IReadOnlySet</a>&lt;<a class="xref" href="JsonApiDotNetCore.Middleware.JsonApiExtension.html">JsonApiExtension</a>&gt;</dt>
142+
<dd></dd>
143+
</dl>
144+
145+
146+
147+
148+
149+
150+
151+
120152
<a id="JsonApiDotNetCore_Middleware_IJsonApiRequest_IsCollection_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiRequest.IsCollection*"></a>
121153

122154
<h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_IsCollection" data-uid="JsonApiDotNetCore.Middleware.IJsonApiRequest.IsCollection">
@@ -420,7 +452,7 @@ <h2 class="section" id="methods">Methods
420452

421453
<h3 id="JsonApiDotNetCore_Middleware_IJsonApiRequest_CopyFrom_JsonApiDotNetCore_Middleware_IJsonApiRequest_" data-uid="JsonApiDotNetCore.Middleware.IJsonApiRequest.CopyFrom(JsonApiDotNetCore.Middleware.IJsonApiRequest)">
422454
CopyFrom(IJsonApiRequest)
423-
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiRequest.cs/#L66"><i class="bi bi-code-slash"></i></a>
455+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Middleware/IJsonApiRequest.cs/#L71"><i class="bi bi-code-slash"></i></a>
424456
</h3>
425457

426458
<div class="markdown level1 summary"><p>Performs a shallow copy.</p>

0 commit comments

Comments
 (0)