Skip to content

Commit 5c87b77

Browse files
bkoelmanbkoelman
committed
Auto-generated documentation from 78e25fb 
1 parent 8fd4eb4 commit 5c87b77

12 files changed

Lines changed: 751 additions & 446 deletions

‎api/JsonApiDotNetCore.Errors.BlockedGetRelationshipException.html‎

Lines changed: 252 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,252 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Class BlockedGetRelationshipException </title>
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7+
<meta name="title" content="Class BlockedGetRelationshipException ">
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+
<meta name="docfx:docurl" content="https://github.com/json-api-dotnet/JsonApiDotNetCore/new/master/apiSpec/new?filename=JsonApiDotNetCore_Errors_BlockedGetRelationshipException.md&amp;value=---%0Auid%3A%20JsonApiDotNetCore.Errors.BlockedGetRelationshipException%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+
<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.Errors.BlockedGetRelationshipException">
91+
92+
93+
94+
<h1 id="JsonApiDotNetCore_Errors_BlockedGetRelationshipException" data-uid="JsonApiDotNetCore.Errors.BlockedGetRelationshipException" class="text-break">
95+
Class BlockedGetRelationshipException <a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Errors/BlockedGetRelationshipException.cs/#L8"><i class="bi bi-code-slash"></i></a>
96+
</h1>
97+
98+
<div class="facts text-secondary">
99+
<dl><dt>Namespace</dt><dd><a class="xref" href="JsonApiDotNetCore.html">JsonApiDotNetCore</a>.<a class="xref" href="JsonApiDotNetCore.Errors.html">Errors</a></dd></dl>
100+
<dl><dt>Assembly</dt><dd>JsonApiDotNetCore.dll</dd></dl>
101+
</div>
102+
103+
<div class="markdown summary"></div>
104+
<div class="markdown conceptual"></div>
105+
106+
<div class="codewrapper">
107+
<pre><code class="lang-csharp hljs">[PublicAPI]
108+
public sealed class BlockedGetRelationshipException : JsonApiException, ISerializable</code></pre>
109+
</div>
110+
111+
112+
113+
114+
<dl class="typelist inheritance">
115+
<dt>Inheritance</dt>
116+
<dd>
117+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
118+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></div>
119+
<div><a class="xref" href="JsonApiDotNetCore.Errors.JsonApiException.html">JsonApiException</a></div>
120+
<div><span class="xref">BlockedGetRelationshipException</span></div>
121+
</dd>
122+
</dl>
123+
124+
<dl class="typelist implements">
125+
<dt>Implements</dt>
126+
<dd>
127+
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.serialization.iserializable">ISerializable</a></div>
128+
</dd>
129+
</dl>
130+
131+
132+
<dl class="typelist inheritedMembers">
133+
<dt>Inherited Members</dt>
134+
<dd>
135+
<div>
136+
<a class="xref" href="JsonApiDotNetCore.Errors.JsonApiException.html#JsonApiDotNetCore_Errors_JsonApiException_Errors">JsonApiException.Errors</a>
137+
</div>
138+
<div>
139+
<a class="xref" href="JsonApiDotNetCore.Errors.JsonApiException.html#JsonApiDotNetCore_Errors_JsonApiException_GetSummary">JsonApiException.GetSummary()</a>
140+
</div>
141+
<div>
142+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.getbaseexception">Exception.GetBaseException()</a>
143+
</div>
144+
<div>
145+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.gettype">Exception.GetType()</a>
146+
</div>
147+
<div>
148+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.tostring">Exception.ToString()</a>
149+
</div>
150+
<div>
151+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.data">Exception.Data</a>
152+
</div>
153+
<div>
154+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.helplink">Exception.HelpLink</a>
155+
</div>
156+
<div>
157+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.hresult">Exception.HResult</a>
158+
</div>
159+
<div>
160+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.innerexception">Exception.InnerException</a>
161+
</div>
162+
<div>
163+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.message">Exception.Message</a>
164+
</div>
165+
<div>
166+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.source">Exception.Source</a>
167+
</div>
168+
<div>
169+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.stacktrace">Exception.StackTrace</a>
170+
</div>
171+
<div>
172+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception.targetsite">Exception.TargetSite</a>
173+
</div>
174+
<div>
175+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
176+
</div>
177+
<div>
178+
<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>
179+
</div>
180+
<div>
181+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
182+
</div>
183+
<div>
184+
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
185+
</div>
186+
</dd></dl>
187+
188+
189+
190+
191+
192+
193+
<h2 class="section" id="constructors">Constructors
194+
</h2>
195+
196+
197+
<a id="JsonApiDotNetCore_Errors_BlockedGetRelationshipException__ctor_" data-uid="JsonApiDotNetCore.Errors.BlockedGetRelationshipException.#ctor*"></a>
198+
199+
<h3 id="JsonApiDotNetCore_Errors_BlockedGetRelationshipException__ctor_JsonApiDotNetCore_Resources_Annotations_RelationshipAttribute_" data-uid="JsonApiDotNetCore.Errors.BlockedGetRelationshipException.#ctor(JsonApiDotNetCore.Resources.Annotations.RelationshipAttribute)">
200+
BlockedGetRelationshipException(RelationshipAttribute)
201+
<a class="header-action link-secondary" title="View source" href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Errors/BlockedGetRelationshipException.cs/#L8"><i class="bi bi-code-slash"></i></a>
202+
</h3>
203+
204+
<div class="markdown level1 summary"></div>
205+
<div class="markdown level1 conceptual"></div>
206+
207+
<div class="codewrapper">
208+
<pre><code class="lang-csharp hljs">public BlockedGetRelationshipException(RelationshipAttribute relationship)</code></pre>
209+
</div>
210+
211+
<h4 class="section">Parameters</h4>
212+
<dl class="parameters">
213+
<dt><code>relationship</code> <a class="xref" href="JsonApiDotNetCore.Resources.Annotations.RelationshipAttribute.html">RelationshipAttribute</a></dt>
214+
<dd></dd>
215+
</dl>
216+
217+
218+
219+
220+
221+
222+
223+
224+
225+
226+
227+
228+
229+
</article>
230+
231+
<div class="contribution d-print-none">
232+
<a href="https://github.com/json-api-dotnet/JsonApiDotNetCore/blob/master/src/JsonApiDotNetCore/Errors/BlockedGetRelationshipException.cs/#L8" class="edit-link">Edit this page</a>
233+
</div>
234+
235+
236+
</div>
237+
238+
<div class="affix">
239+
<nav id="affix"></nav>
240+
</div>
241+
</main>
242+
243+
244+
<footer class="border-top text-secondary">
245+
<div class="container-xxl">
246+
<div class="flex-fill">
247+
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
248+
</div>
249+
</div>
250+
</footer>
251+
</body>
252+
</html>

‎api/JsonApiDotNetCore.Errors.JsonApiException.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ <h1 id="JsonApiDotNetCore_Errors_JsonApiException" data-uid="JsonApiDotNetCore.E
131131
<dl class="typelist derived">
132132
<dt>Derived</dt>
133133
<dd>
134+
<div><a class="xref" href="JsonApiDotNetCore.Errors.BlockedGetRelationshipException.html">BlockedGetRelationshipException</a></div>
134135
<div><a class="xref" href="JsonApiDotNetCore.Errors.CannotClearRequiredRelationshipException.html">CannotClearRequiredRelationshipException</a></div>
135136
<div><a class="xref" href="JsonApiDotNetCore.Errors.DuplicateLocalIdValueException.html">DuplicateLocalIdValueException</a></div>
136137
<div><a class="xref" href="JsonApiDotNetCore.Errors.FailedOperationException.html">FailedOperationException</a></div>

‎api/JsonApiDotNetCore.Errors.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,10 @@ <h1 id="JsonApiDotNetCore_Errors" data-uid="JsonApiDotNetCore.Errors" class="tex
9797
<h3 id="classes">
9898
Classes
9999
</h3>
100+
<dl class="jumplist">
101+
<dt><a class="xref" href="JsonApiDotNetCore.Errors.BlockedGetRelationshipException.html">BlockedGetRelationshipException</a></dt>
102+
<dd></dd>
103+
</dl>
100104
<dl class="jumplist">
101105
<dt><a class="xref" href="JsonApiDotNetCore.Errors.CannotClearRequiredRelationshipException.html">CannotClearRequiredRelationshipException</a></dt>
102106
<dd><p>The error that is thrown when a required relationship is cleared.</p>

‎api/JsonApiDotNetCore.Resources.Annotations.HasManyCapabilities.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ <h2 id="fields">Fields
150150
<dt id="JsonApiDotNetCore_Resources_Annotations_HasManyCapabilities_AllowView"><code>AllowView = 1</code></dt>
151151
<dd><p>Whether or not the relationship can be returned in responses. Attempts to explicitly request it via the <code>fields</code> query string parameter when
152152
disabled will return an HTTP 400 response. Otherwise, the relationship (and its related resources, when included) are silently omitted.</p>
153-
<p>Note this setting does not affect retrieving the related resources directly.</p>
153+
<p>Note this setting affects the secondary and relationship endpoints, but it does not affect retrieving the related resources directly.</p>
154154
</dd>
155155

156156
<dt id="JsonApiDotNetCore_Resources_Annotations_HasManyCapabilities_None"><code>None = 0</code></dt>

‎api/JsonApiDotNetCore.Resources.Annotations.HasOneCapabilities.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ <h2 id="fields">Fields
137137
<dt id="JsonApiDotNetCore_Resources_Annotations_HasOneCapabilities_AllowView"><code>AllowView = 1</code></dt>
138138
<dd><p>Whether or not the relationship can be returned in responses. Attempts to explicitly request it via the <code>fields</code> query string parameter when
139139
disabled will return an HTTP 400 response. Otherwise, the relationship (and its related resources, when included) are silently omitted.</p>
140-
<p>Note this setting does not affect retrieving the related resources directly.</p>
140+
<p>Note this setting affects the secondary and relationship endpoints, but it does not affect retrieving the related resources directly.</p>
141141
</dd>
142142

143143
<dt id="JsonApiDotNetCore_Resources_Annotations_HasOneCapabilities_None"><code>None = 0</code></dt>

0 commit comments

Comments
 (0)