-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.html
261 lines (245 loc) · 11.9 KB
/
index.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
250
251
252
253
254
255
256
257
258
259
260
261
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Halil Cetiner</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="./assets/bootstrap.min.css" rel="stylesheet" media="screen">
<link href="./assets/prettify.css" rel="stylesheet" media="screen">
<link href="./assets/style.css" rel="stylesheet" media="screen, print">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.5.0/css/all.css" integrity="sha384-B4dIYHKNBt8Bc12p+WXckhzcICo0wtJAoU8YZTY5qE0Id1GSseTk6S+L3BlXeVIU"
crossorigin="anonymous">
<style type="text/css">
:root #content>#center>.dose>.dosesingle,
:root #content>#right>.dose>.dosesingle,
:root #header+#content>#left>#rlblock_left {
display: none !important;
}
</style>
<script type="text/javascript" charset="utf-8" data-requirecontext="_" data-requiremodule="jquery" src="./assets/jquery.min.js"></script>
</head>
<body>
<div class="container-fluid">
<div class="row-fluid">
<div id="sidenav" class="span2">
<nav id="scrollingNav">
<ul class="sidenav nav nav-list">
<li class="nav-header active" data-group="User"><a href="#api-User">User</a></li>
<li data-group="User" data-name="GetUser">
<a href="#endpoint-0">Get User Information</a>
<a href="#endpoint-1">Update User Information</a>
</li>
</ul>
</nav>
</div>
<div id="content">
<div id="header">
<div class="pull-left">
<h1>Halil Cetiner</h1>
<h2>apiDoc of myself 👨‍💻</h2>
</div>
<div class="clearfix"></div>
</div>
<div id="sections">
<section id="api-User" data-name="User">
<h1>User</h1>
<div id="endpoint-0">
<article>
<div class="pull-left">
<h1>User - Get User Information</h1>
</div>
<div class="clearfix"></div>
<pre class="prettyprint language-html prettyprinted" data-type="get"><code><span class="pln">/user</span></code></pre>
<h2>Success 200</h2>
<table>
<thead>
<tr>
<th style="width: 30%">Field</th>
<th style="width: 10%">Type</th>
<th style="width: 70%">Sample Response</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">firstname</td>
<td>String</td>
<td>
<p>Halil</p>
</td>
</tr>
<tr>
<td class="code">lastname</td>
<td>String</td>
<td>
<p>Cetiner</p>
</td>
</tr>
<tr>
<td class="code">current_company</td>
<td>String</td>
<td>
<p><a href="https://yelp.com" target="_blank">Yelp</a></p>
</td>
</tr>
<tr>
<td class="code">position</td>
<td>String</td>
<td>
<p>Software Engineer</p>
</td>
</tr>
<tr>
<td class="code">university</td>
<td>String</td>
<td>
<p><a href="https://boun.edu.tr" target="_blank">Bogazici University</a></p>
</td>
</tr>
<tr>
<td class="code">github</td>
<td>String</td>
<td>
<p><a href="https://github.com/bayneri" target="_blank"><i class="fab fa-github"></i>/bayneri</a></p>
</td>
</tr>
<tr>
<td class="code">linkedin</td>
<td>String</td>
<td>
<p><a href="https://linkedin.com/in/cetinerhalil" target="_blank"><i class="fab fa-linkedin"></i>/cetinerhalil</a></p>
</td>
</tr>
<tr>
<td class="code">blog</td>
<td>String</td>
<td>
<p><a href="https://medium.com/@cetiner" target="_blank"><i class="fab fa-medium"></i>/@cetiner</a></p>
</td>
</tr>
<tr>
<td class="code">twitter</td>
<td>String</td>
<td>
<p><a href="https://twitter.com/bayneri" target="_blank"><i class="fab fa-twitter"></i>/bayneri</a></p>
</td>
</tr>
<tr>
<td class="code">instagram</td>
<td>String</td>
<td>
<p><a href="https://instagram.com/cetinerhalil" target="_blank"><i class="fab fa-instagram"></i>/cetinerhalil</a></p>
</td>
</tr>
<tr>
<td class="code">facebook</td>
<td>String</td>
<td>
<p><a href="https://facebook.com/cetinerhalil" target="_blank"><i class="fab fa-facebook"></i>/cetinerhalil</a></p>
</td>
</tr>
</tbody>
</table>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active">
<a href="#success-response">Success-Response:</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="success-response">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code><span class="pln"> HTTP</span><span class="pun">/</span><span class="lit">1.1</span><span class="pln"> </span><span class="lit">200</span><span class="pln"> OK
</span><span class="pun">{</span><span class="pln">
</span><span class="str">"firstname"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Halil"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"lastname"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Cetiner"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"current_company"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Yelp"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"position"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Software Engineer"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"university"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"Bogazici University"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"github"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"gh/bayneri"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"linkedin"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"li/cetinerhalil"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"blog"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"md/@cetiner"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"twitter"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"tw/bayneri"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"instagram"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"ig/cetinerhalil"</span><span class="pun">,</span><span class="pln">
</span><span class="str">"facebook"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"fb/cetinerhalil"</span><span class="pun">,</span><span class="pln">
</span><span class="pun">}</span></code></pre>
</div>
</div>
<h2>Error 4xx</h2>
<table>
<thead>
<tr>
<th style="width: 30%">Field</th>
<th style="width: 70%">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">UserNotFound</td>
<td>
<p>I'm usually accessible but if you get this error, try halil@cetiner.me.</p>
</td>
</tr>
</tbody>
</table>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active">
<a href="#error-response">Error-Response:</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="error-response">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code><span class="pln"> HTTP</span><span class="pun">/</span><span class="lit">1.1</span><span class="pln"> </span><span class="lit">404</span><span class="pln"> </span><span class="typ">undefined</span><span class="pln">
</span><span class="pun">{</span><span class="pln">
</span><span class="str">"error"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"UserNotFound"</span><span class="pln">
</span><span class="pun">}</span></code></pre>
</div>
</div>
<div id="endpoint-1">
<article>
<div class="pull-left">
<h1>User - Update User Information</h1>
</div>
<div class="clearfix"></div>
<pre class="prettyprint language-html prettyprinted" data-type="patch"><code><span class="pln">/user</span></code></pre>
<h2>Error 4xx</h2>
<table>
<thead>
<tr>
<th style="width: 30%">Field</th>
<th style="width: 70%">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="code">UpdateNotAllowed</td>
<td>
<p>Don't you dare try to get into my personal space. “I'm a very private person.”.</p>
</td>
</tr>
</tbody>
</table>
<ul class="nav nav-tabs nav-tabs-examples">
<li class="active">
<a href="#error-response">Error-Response:</a>
</li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="error-response">
<pre class="prettyprint language-json prettyprinted" data-type="json"><code><span class="pln"> HTTP</span><span class="pun">/</span><span class="lit">1.1</span><span class="pln"> </span><span class="lit">403</span><span class="pln"> </span><span class="typ">Forbidden</span><span class="pln">
</span><span class="pun">{</span><span class="pln">
</span><span class="str">"error"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"UpdateNotAllowed"</span><span class="pln">
</span><span class="pun">}</span></code></pre>
</div>
</div>
</article>
</div>
<div id="generator">
<div class="content">
Built with <a href="https://github.com/cetinerhalil/adapt">adapt - apiDoc as personal website template </a> • /
Developed based on <a href="http://apidocjs.com/">apiDoc</a> template
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>