-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathEpochtalkServerWeb.Controllers.ErrorJSON.html
249 lines (189 loc) · 13.7 KB
/
EpochtalkServerWeb.Controllers.ErrorJSON.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.37.2">
<meta name="project" content="epochtalk_server v0.1.0">
<title>EpochtalkServerWeb.Controllers.ErrorJSON — epochtalk_server v0.1.0</title>
<link rel="stylesheet" href="dist/html-elixir-6X3L5KMG.css" />
<script defer src="dist/sidebar_items-C8922E45.js"></script>
<script defer src="docs_config.js"></script>
<script defer src="dist/html-6XHBGSGW.js"></script>
</head>
<body>
<script>(()=>{var t="ex_doc:settings",e="dark";var o="dark",s="light";var E="sidebar_state",n="closed";var r="sidebar_width";var a="sidebar-open";var i=new URLSearchParams(window.location.search),S=i.get("theme")||JSON.parse(localStorage.getItem(t)||"{}").theme;(S===o||S!==s&&window.matchMedia("(prefers-color-scheme: dark)").matches)&&document.body.classList.add(e);var d=sessionStorage.getItem(E),A=d!==n&&!window.matchMedia(`screen and (max-width: ${768}px)`).matches;document.body.classList.toggle(a,A);var c=sessionStorage.getItem(r);c&&document.body.style.setProperty("--sidebarWidth",`${c}px`);var p=/(Macintosh|iPhone|iPad|iPod)/.test(window.navigator.userAgent);document.documentElement.classList.toggle("apple-os",p);})();
</script>
<div class="body-wrapper">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<div>
<a href="api-reference.html" class="sidebar-projectName" translate="no">
epochtalk_server
</a>
<div class="sidebar-projectVersion" translate="no">
v0.1.0
</div>
</div>
</div>
<ul id="sidebar-list-nav" class="sidebar-list-nav" role="tablist" data-extras=""></ul>
</div>
</nav>
<output role="status" id="toast"></output>
<main class="content page-module" id="main" data-type="modules">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of epochtalk_server</span>
<input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search" tabindex="-1">
<i class="ri-search-2-line ri-lg" aria-hidden="true"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<div id="top-content">
<div class="heading-with-actions top-heading">
<h1>
<span translate="no">EpochtalkServerWeb.Controllers.ErrorJSON</span>
<small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>
</h1>
</div>
<section id="moduledoc">
<p>Renders and formats error data, in JSON format for frontend</p>
</section>
</div>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#render/1" data-no-tooltip="" translate="no">render(template)</a>
</div>
<div class="summary-synopsis"><p>Render has been modified to handle and all types of errors. Epochtalk Server sends all
errors through this render in order to create a consistent error JSON.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#render/2" data-no-tooltip="" translate="no">render(template, assigns)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#template_not_found/2" data-no-tooltip="" translate="no">template_not_found(template, assigns)</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="render/1">
<div class="detail-header">
<a href="#render/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">render(template)</h1>
</div>
</div>
<section class="docstring">
<p>Render has been modified to handle and all types of errors. Epochtalk Server sends all
errors through this render in order to create a consistent error JSON.</p><h2 id="render/1-example" class="section-heading">
<a href="#render/1-example" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Example</span>
</h2>
<pre><code class="makeup elixir" translate="no"><span class="gp unselectable">iex> </span><span class="nc">EpochtalkServerWeb.Controllers.ErrorJSON</span><span class="o">.</span><span class="n">render</span><span class="p" data-group-id="2806365389-1">(</span><span class="s">"500.json"</span><span class="p" data-group-id="2806365389-1">)</span><span class="w">
</span><span class="p" data-group-id="2806365389-2">%{</span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s">"Internal Server Error"</span><span class="p">,</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Request Error"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p" data-group-id="2806365389-2">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">EpochtalkServerWeb.Controllers.ErrorJSON</span><span class="o">.</span><span class="n">render</span><span class="p" data-group-id="2806365389-3">(</span><span class="s">"400.json"</span><span class="p" data-group-id="2806365389-3">)</span><span class="w">
</span><span class="p" data-group-id="2806365389-4">%{</span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s">"Bad Request"</span><span class="p">,</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Request Error"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">400</span><span class="p" data-group-id="2806365389-4">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">EpochtalkServerWeb.Controllers.ErrorJSON</span><span class="o">.</span><span class="n">render</span><span class="p" data-group-id="2806365389-5">(</span><span class="s">"404.json"</span><span class="p" data-group-id="2806365389-5">)</span><span class="w">
</span><span class="p" data-group-id="2806365389-6">%{</span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s">"Not Found"</span><span class="p">,</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Request Error"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">404</span><span class="p" data-group-id="2806365389-6">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">EpochtalkServerWeb.Controllers.ErrorJSON</span><span class="o">.</span><span class="n">render</span><span class="p" data-group-id="2806365389-7">(</span><span class="s">"401.json"</span><span class="p" data-group-id="2806365389-7">)</span><span class="w">
</span><span class="p" data-group-id="2806365389-8">%{</span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s">"Unauthorized"</span><span class="p">,</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Request Error"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">401</span><span class="p" data-group-id="2806365389-8">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">EpochtalkServerWeb.Controllers.ErrorJSON</span><span class="o">.</span><span class="n">template_not_found</span><span class="p" data-group-id="2806365389-9">(</span><span class="s">"DoesNotExist.json"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2806365389-10">%{</span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Custom Error Message"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p" data-group-id="2806365389-10">}</span><span class="p" data-group-id="2806365389-9">)</span><span class="w">
</span><span class="p" data-group-id="2806365389-11">%{</span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s">"Internal Server Error"</span><span class="p">,</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Custom Error Message"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">500</span><span class="p" data-group-id="2806365389-11">}</span><span class="w">
</span><span class="gp unselectable">iex> </span><span class="nc">EpochtalkServerWeb.Controllers.ErrorJSON</span><span class="o">.</span><span class="n">template_not_found</span><span class="p" data-group-id="2806365389-12">(</span><span class="s">"DoesNotExist.json"</span><span class="p">,</span><span class="w"> </span><span class="p" data-group-id="2806365389-13">%{</span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Custom Error Message"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">404</span><span class="p" data-group-id="2806365389-13">}</span><span class="p" data-group-id="2806365389-12">)</span><span class="w">
</span><span class="p" data-group-id="2806365389-14">%{</span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s">"Not Found"</span><span class="p">,</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s">"Custom Error Message"</span><span class="p">,</span><span class="w"> </span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="mi">404</span><span class="p" data-group-id="2806365389-14">}</span></code></pre>
</section>
</section>
<section class="detail" id="render/2">
<div class="detail-header">
<a href="#render/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">render(template, assigns)</h1>
</div>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="template_not_found/2">
<div class="detail-header">
<a href="#template_not_found/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<div class="heading-with-actions">
<h1 class="signature" translate="no">template_not_found(template, assigns)</h1>
</div>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="epochtalk_server.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.37.2) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</main>
</div>
</body>
</html>