Skip to content

Commit 0ca0187

Browse files
jasonrudolphjasonrudolph
committed
Remove misleading parameters in notifications API
1 parent d760491 commit 0ca0187

4 files changed

Lines changed: 25 additions & 46 deletions

File tree

‎index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ <h1 id="the-github-api">The GitHub API</h1>
4444

4545
<p>For the new API v3, start browsing the resources on the right »</p>
4646

47-
<p>View the <a href="#changes">API Changelog</a> for information on existing and
47+
<p>View the <a href="/changes">API Changelog</a> for information on existing and
4848
planned changes to the API.</p>
4949

5050
<h2 id="current-version">Current Version</h2>

‎v3/activity/notifications/index.html‎

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -226,13 +226,7 @@ <h2 id="mark-as-read">Mark as read</h2>
226226
<h3 id="input">Input</h3>
227227

228228
<dl>
229-
<dt>unread</dt>
230-
<dd>
231-
<strong>Boolean</strong> Changes the unread status of the threads.</dd>
232-
<dt>read</dt>
233-
<dd>
234-
<strong>Boolean</strong> Inverse of “unread”.</dd>
235-
<dt>last_read_at</dt>
229+
<dt>last_read_at</dt>
236230
<dd>
237231
<em>Optional</em> <strong>Time</strong> Describes the last point that notifications were checked. Anything
238232
updated since this time will not be updated. Default: Now. Expected in ISO
@@ -254,13 +248,7 @@ <h2 id="mark-notifications-as-read-in-a-repository">Mark notifications as read i
254248
<h3 id="input-1">Input</h3>
255249

256250
<dl>
257-
<dt>unread</dt>
258-
<dd>
259-
<strong>Boolean</strong> Changes the unread status of the threads.</dd>
260-
<dt>read</dt>
261-
<dd>
262-
<strong>Boolean</strong> Inverse of “unread”.</dd>
263-
<dt>last_read_at</dt>
251+
<dt>last_read_at</dt>
264252
<dd>
265253
<em>Optional</em> <strong>Time</strong> Describes the last point that notifications were checked. Anything
266254
updated since this time will not be updated. Default: Now. Expected in ISO
@@ -319,16 +307,7 @@ <h2 id="mark-a-thread-as-read">Mark a thread as read</h2>
319307
<pre><code>PATCH /notifications/threads/:id
320308
</code></pre>
321309

322-
<h3 id="input-2">Input</h3>
323-
324-
<dl>
325-
<dt>unread</dt>
326-
<dd>
327-
<strong>Boolean</strong> Changes the unread status of the threads.</dd>
328-
<dt>read</dt>
329-
<dd>
330-
<strong>Boolean</strong> Inverse of “unread”.</dd>
331-
</dl><h3 id="response-5">Response</h3>
310+
<h3 id="response-5">Response</h3>
332311

333312
<pre class="headers"><code>Status: 205 Reset Content
334313
X-RateLimit-Limit: 5000
@@ -367,7 +346,7 @@ <h2 id="set-a-thread-subscription">Set a Thread Subscription</h2>
367346
<pre><code>PUT /notifications/threads/1/subscription
368347
</code></pre>
369348

370-
<h3 id="input-3">Input</h3>
349+
<h3 id="input-2">Input</h3>
371350

372351
<dl>
373352
<dt>subscribed</dt>

‎v3/gists/comments/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ <h3 id="response">Response</h3>
6363
<pre class="highlight"><code class="language-javascript"><span class="p">[</span>
6464
<span class="p">{</span>
6565
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
66-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c39d10a5f0612e51471f/comments/1"</span><span class="p">,</span>
66+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/55366e31a3e7c1d65485/comments/1"</span><span class="p">,</span>
6767
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"Just commenting for the sake of commenting"</span><span class="p">,</span>
6868
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
6969
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>
@@ -89,7 +89,7 @@ <h3 id="response-1">Response</h3>
8989

9090
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
9191
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
92-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c39d10a5f0612e51471f/comments/1"</span><span class="p">,</span>
92+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/55366e31a3e7c1d65485/comments/1"</span><span class="p">,</span>
9393
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"Just commenting for the sake of commenting"</span><span class="p">,</span>
9494
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
9595
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>
@@ -126,7 +126,7 @@ <h3 id="response-2">Response</h3>
126126

127127
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
128128
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
129-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c39d10a5f0612e51471f/comments/1"</span><span class="p">,</span>
129+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/55366e31a3e7c1d65485/comments/1"</span><span class="p">,</span>
130130
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"Just commenting for the sake of commenting"</span><span class="p">,</span>
131131
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
132132
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>
@@ -162,7 +162,7 @@ <h3 id="response-3">Response</h3>
162162

163163
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
164164
<span class="s2">"id"</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
165-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c39d10a5f0612e51471f/comments/1"</span><span class="p">,</span>
165+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/55366e31a3e7c1d65485/comments/1"</span><span class="p">,</span>
166166
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"Just commenting for the sake of commenting"</span><span class="p">,</span>
167167
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
168168
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>

‎v3/gists/index.html‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h3 id="parameters">Parameters</h3>
9797

9898
<pre class="highlight"><code class="language-javascript"><span class="p">[</span>
9999
<span class="p">{</span>
100-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/2caf78464c49c3948c07"</span><span class="p">,</span>
100+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9fa1ed020cad401c2720"</span><span class="p">,</span>
101101
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
102102
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"description of gist"</span><span class="p">,</span>
103103
<span class="s2">"public"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
@@ -116,7 +116,7 @@ <h3 id="parameters">Parameters</h3>
116116
<span class="p">}</span>
117117
<span class="p">},</span>
118118
<span class="s2">"comments"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
119-
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/5662124ef1429afbe781/comments/"</span><span class="p">,</span>
119+
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/6a9a5773ec48930b8172/comments/"</span><span class="p">,</span>
120120
<span class="s2">"html_url"</span><span class="o">:</span> <span class="s2">"https://gist.github.com/1"</span><span class="p">,</span>
121121
<span class="s2">"git_pull_url"</span><span class="o">:</span> <span class="s2">"git://gist.github.com/1.git"</span><span class="p">,</span>
122122
<span class="s2">"git_push_url"</span><span class="o">:</span> <span class="s2">"git@gist.github.com:1.git"</span><span class="p">,</span>
@@ -138,7 +138,7 @@ <h3 id="response-1">Response</h3>
138138
X-RateLimit-Remaining: 4999</code></pre>
139139

140140
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
141-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/2caf78464c49c3948c07"</span><span class="p">,</span>
141+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9fa1ed020cad401c2720"</span><span class="p">,</span>
142142
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
143143
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"description of gist"</span><span class="p">,</span>
144144
<span class="s2">"public"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
@@ -157,7 +157,7 @@ <h3 id="response-1">Response</h3>
157157
<span class="p">}</span>
158158
<span class="p">},</span>
159159
<span class="s2">"comments"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
160-
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/5662124ef1429afbe781/comments/"</span><span class="p">,</span>
160+
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/6a9a5773ec48930b8172/comments/"</span><span class="p">,</span>
161161
<span class="s2">"html_url"</span><span class="o">:</span> <span class="s2">"https://gist.github.com/1"</span><span class="p">,</span>
162162
<span class="s2">"git_pull_url"</span><span class="o">:</span> <span class="s2">"git://gist.github.com/1.git"</span><span class="p">,</span>
163163
<span class="s2">"git_push_url"</span><span class="o">:</span> <span class="s2">"git@gist.github.com:1.git"</span><span class="p">,</span>
@@ -171,13 +171,13 @@ <h3 id="response-1">Response</h3>
171171
<span class="s2">"gravatar_id"</span><span class="o">:</span> <span class="s2">"somehexcode"</span><span class="p">,</span>
172172
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
173173
<span class="p">},</span>
174-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/d4dcf4765fc9c83ad354"</span><span class="p">,</span>
174+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/4f2824ca45fee3f6d0b1"</span><span class="p">,</span>
175175
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-04-14T16:00:49Z"</span>
176176
<span class="p">}</span>
177177
<span class="p">],</span>
178178
<span class="s2">"history"</span><span class="o">:</span> <span class="p">[</span>
179179
<span class="p">{</span>
180-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9b84b4234001ddd899be"</span><span class="p">,</span>
180+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c3cc9583e4457c3c50ac"</span><span class="p">,</span>
181181
<span class="s2">"version"</span><span class="o">:</span> <span class="s2">"57a7f021a713b1c5a6a199b54cc514735d2d462f"</span><span class="p">,</span>
182182
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
183183
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>
@@ -241,7 +241,7 @@ <h3 id="response-2">Response</h3>
241241
X-RateLimit-Remaining: 4999</code></pre>
242242

243243
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
244-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/2caf78464c49c3948c07"</span><span class="p">,</span>
244+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9fa1ed020cad401c2720"</span><span class="p">,</span>
245245
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
246246
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"description of gist"</span><span class="p">,</span>
247247
<span class="s2">"public"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
@@ -260,7 +260,7 @@ <h3 id="response-2">Response</h3>
260260
<span class="p">}</span>
261261
<span class="p">},</span>
262262
<span class="s2">"comments"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
263-
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/5662124ef1429afbe781/comments/"</span><span class="p">,</span>
263+
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/6a9a5773ec48930b8172/comments/"</span><span class="p">,</span>
264264
<span class="s2">"html_url"</span><span class="o">:</span> <span class="s2">"https://gist.github.com/1"</span><span class="p">,</span>
265265
<span class="s2">"git_pull_url"</span><span class="o">:</span> <span class="s2">"git://gist.github.com/1.git"</span><span class="p">,</span>
266266
<span class="s2">"git_push_url"</span><span class="o">:</span> <span class="s2">"git@gist.github.com:1.git"</span><span class="p">,</span>
@@ -274,13 +274,13 @@ <h3 id="response-2">Response</h3>
274274
<span class="s2">"gravatar_id"</span><span class="o">:</span> <span class="s2">"somehexcode"</span><span class="p">,</span>
275275
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
276276
<span class="p">},</span>
277-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/d4dcf4765fc9c83ad354"</span><span class="p">,</span>
277+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/4f2824ca45fee3f6d0b1"</span><span class="p">,</span>
278278
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-04-14T16:00:49Z"</span>
279279
<span class="p">}</span>
280280
<span class="p">],</span>
281281
<span class="s2">"history"</span><span class="o">:</span> <span class="p">[</span>
282282
<span class="p">{</span>
283-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9b84b4234001ddd899be"</span><span class="p">,</span>
283+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c3cc9583e4457c3c50ac"</span><span class="p">,</span>
284284
<span class="s2">"version"</span><span class="o">:</span> <span class="s2">"57a7f021a713b1c5a6a199b54cc514735d2d462f"</span><span class="p">,</span>
285285
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
286286
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>
@@ -354,7 +354,7 @@ <h3 id="response-3">Response</h3>
354354
X-RateLimit-Remaining: 4999</code></pre>
355355

356356
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
357-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/2caf78464c49c3948c07"</span><span class="p">,</span>
357+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9fa1ed020cad401c2720"</span><span class="p">,</span>
358358
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
359359
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"description of gist"</span><span class="p">,</span>
360360
<span class="s2">"public"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
@@ -373,7 +373,7 @@ <h3 id="response-3">Response</h3>
373373
<span class="p">}</span>
374374
<span class="p">},</span>
375375
<span class="s2">"comments"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
376-
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/5662124ef1429afbe781/comments/"</span><span class="p">,</span>
376+
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/6a9a5773ec48930b8172/comments/"</span><span class="p">,</span>
377377
<span class="s2">"html_url"</span><span class="o">:</span> <span class="s2">"https://gist.github.com/1"</span><span class="p">,</span>
378378
<span class="s2">"git_pull_url"</span><span class="o">:</span> <span class="s2">"git://gist.github.com/1.git"</span><span class="p">,</span>
379379
<span class="s2">"git_push_url"</span><span class="o">:</span> <span class="s2">"git@gist.github.com:1.git"</span><span class="p">,</span>
@@ -387,13 +387,13 @@ <h3 id="response-3">Response</h3>
387387
<span class="s2">"gravatar_id"</span><span class="o">:</span> <span class="s2">"somehexcode"</span><span class="p">,</span>
388388
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/users/octocat"</span>
389389
<span class="p">},</span>
390-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/d4dcf4765fc9c83ad354"</span><span class="p">,</span>
390+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/4f2824ca45fee3f6d0b1"</span><span class="p">,</span>
391391
<span class="s2">"created_at"</span><span class="o">:</span> <span class="s2">"2011-04-14T16:00:49Z"</span>
392392
<span class="p">}</span>
393393
<span class="p">],</span>
394394
<span class="s2">"history"</span><span class="o">:</span> <span class="p">[</span>
395395
<span class="p">{</span>
396-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9b84b4234001ddd899be"</span><span class="p">,</span>
396+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/c3cc9583e4457c3c50ac"</span><span class="p">,</span>
397397
<span class="s2">"version"</span><span class="o">:</span> <span class="s2">"57a7f021a713b1c5a6a199b54cc514735d2d462f"</span><span class="p">,</span>
398398
<span class="s2">"user"</span><span class="o">:</span> <span class="p">{</span>
399399
<span class="s2">"login"</span><span class="o">:</span> <span class="s2">"octocat"</span><span class="p">,</span>
@@ -466,7 +466,7 @@ <h3 id="response-6">Response</h3>
466466
X-RateLimit-Remaining: 4999</code></pre>
467467

468468
<pre class="highlight"><code class="language-javascript"><span class="p">{</span>
469-
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/2caf78464c49c3948c07"</span><span class="p">,</span>
469+
<span class="s2">"url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/9fa1ed020cad401c2720"</span><span class="p">,</span>
470470
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"1"</span><span class="p">,</span>
471471
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"description of gist"</span><span class="p">,</span>
472472
<span class="s2">"public"</span><span class="o">:</span> <span class="kc">true</span><span class="p">,</span>
@@ -485,7 +485,7 @@ <h3 id="response-6">Response</h3>
485485
<span class="p">}</span>
486486
<span class="p">},</span>
487487
<span class="s2">"comments"</span><span class="o">:</span> <span class="mi">0</span><span class="p">,</span>
488-
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/5662124ef1429afbe781/comments/"</span><span class="p">,</span>
488+
<span class="s2">"comments_url"</span><span class="o">:</span> <span class="s2">"https://api.github.com/gists/6a9a5773ec48930b8172/comments/"</span><span class="p">,</span>
489489
<span class="s2">"html_url"</span><span class="o">:</span> <span class="s2">"https://gist.github.com/1"</span><span class="p">,</span>
490490
<span class="s2">"git_pull_url"</span><span class="o">:</span> <span class="s2">"git://gist.github.com/1.git"</span><span class="p">,</span>
491491
<span class="s2">"git_push_url"</span><span class="o">:</span> <span class="s2">"git@gist.github.com:1.git"</span><span class="p">,</span>

0 commit comments

Comments
 (0)