Skip to content

Commit 20a3387

Browse files
author
Hubot
committed
P U B L I S H :shipit:
1 parent 6710f7c commit 20a3387

File tree

6 files changed

+103
-106
lines changed

6 files changed

+103
-106
lines changed

changes/index.html

Lines changed: 86 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -2493,6 +2493,35 @@ <h2 class="title">
24932493
you have any questions or feedback, <a href="https://github.com/contact?form%5Bsubject%5D=API+org+scopes">get in touch</a>.</p>
24942494

24952495

2496+
</div>
2497+
2498+
<div class="change" id="/changes/2014-02-24-wildcard-event-for-webhooks/">
2499+
<h2 class="title">
2500+
<a href="/changes/2014-02-24-wildcard-event-for-webhooks/">Wildcard Event for Webhooks</a>
2501+
</h2>
2502+
2503+
<div class="meta">
2504+
<ul>
2505+
<li class="published">
2506+
<span class="octicon octicon-calendar"></span>
2507+
February 24, 2014
2508+
2509+
</li>
2510+
<li class="who_when">
2511+
<img height="16" width="16" src="https://github.com/kdaigle.png" alt="Avatar for kdaigle">
2512+
<a href="https://github.com/kdaigle">kdaigle</a>
2513+
</li>
2514+
</ul>
2515+
</div>
2516+
2517+
<p>We’ve made a small change to make it easier for webhook integrators to receive “everything”.
2518+
Instead of adding every event to your webhook, you can now opt-in to all events (including
2519+
all new events in the future) by using the <a href="/webhooks/#wildcard-event">wildcard event</a> (<code>*</code>).</p>
2520+
2521+
<p>If you add this event to an existing webhook, we’ll remove the existing specific events and
2522+
send you payloads for all supported events. As we add new events, you’ll automatically
2523+
begin receiving those too.</p>
2524+
24962525
</div>
24972526

24982527
<div class="change" id="/changes/2014-02-24-finer-grained-scopes-for-ssh-keys/">
@@ -2544,35 +2573,6 @@ <h2 id="deleting-keys-when-revoking-a-token">Deleting keys when revoking a token
25442573
<p>As always, if you have any questions or feedback, <a href="https://github.com/contact?form%5Bsubject%5D=API+improvements+for+SSH+keys">please get in touch</a>.</p>
25452574

25462575

2547-
</div>
2548-
2549-
<div class="change" id="/changes/2014-02-24-wildcard-event-for-webhooks/">
2550-
<h2 class="title">
2551-
<a href="/changes/2014-02-24-wildcard-event-for-webhooks/">Wildcard Event for Webhooks</a>
2552-
</h2>
2553-
2554-
<div class="meta">
2555-
<ul>
2556-
<li class="published">
2557-
<span class="octicon octicon-calendar"></span>
2558-
February 24, 2014
2559-
2560-
</li>
2561-
<li class="who_when">
2562-
<img height="16" width="16" src="https://github.com/kdaigle.png" alt="Avatar for kdaigle">
2563-
<a href="https://github.com/kdaigle">kdaigle</a>
2564-
</li>
2565-
</ul>
2566-
</div>
2567-
2568-
<p>We’ve made a small change to make it easier for webhook integrators to receive “everything”.
2569-
Instead of adding every event to your webhook, you can now opt-in to all events (including
2570-
all new events in the future) by using the <a href="/webhooks/#wildcard-event">wildcard event</a> (<code>*</code>).</p>
2571-
2572-
<p>If you add this event to an existing webhook, we’ll remove the existing specific events and
2573-
send you payloads for all supported events. As we add new events, you’ll automatically
2574-
begin receiving those too.</p>
2575-
25762576
</div>
25772577

25782578
<div class="change" id="/changes/2014-02-21-gist-raw-file-url-change/">
@@ -2653,9 +2653,9 @@ <h2 class="title">
26532653

26542654
</div>
26552655

2656-
<div class="change" id="/changes/2014-2-10-ping-event-for-webhooks/">
2656+
<div class="change" id="/changes/2014-02-10-repo-hook-scopes/">
26572657
<h2 class="title">
2658-
<a href="/changes/2014-2-10-ping-event-for-webhooks/">Ping Event for Webhooks</a>
2658+
<a href="/changes/2014-02-10-repo-hook-scopes/">New scopes for managing repository hooks</a>
26592659
</h2>
26602660

26612661
<div class="meta">
@@ -2666,29 +2666,34 @@ <h2 class="title">
26662666

26672667
</li>
26682668
<li class="who_when">
2669-
<img height="16" width="16" src="https://github.com/kdaigle.png" alt="Avatar for kdaigle">
2670-
<a href="https://github.com/kdaigle">kdaigle</a>
2669+
<img height="16" width="16" src="https://github.com/pengwynn.png" alt="Avatar for pengwynn">
2670+
<a href="https://github.com/pengwynn">pengwynn</a>
26712671
</li>
26722672
</ul>
26732673
</div>
26742674

2675-
<p>With the release of our <a href="https://github.com/blog/1778-webhooks-level-up">new webhook UI</a>, we included a new
2676-
<a href="/webhooks/#ping-event">ping event</a> that webhooks will receive. When you
2677-
create a new webhook, we will send this event as an initial test of the webhook.</p>
2675+
<p>Many third party services need to set up <a href="http://developer.github.com/v3/repos/hooks/">hooks</a> in order to act upon events
2676+
in your repositories. Today, we’ve introduced three new <a href="http://developer.github.com/v3/oauth/#scopes">scopes</a> that provide
2677+
more granular access to your repository hooks without allowing access to your
2678+
repository contents:</p>
26782679

2679-
<p>The ping is only informational, doesn’t need to be responded to in a specific way,
2680-
and nothing bad will happen if you respond with an error. It’s just a quick
2681-
“hello world” to let you know you set everything up correctly.</p>
2680+
<ul>
2681+
<li>
2682+
<code>read:repo_hook</code> grants read and ping access to hooks in public or private repositories.</li>
2683+
<li>
2684+
<code>write:repo_hook</code> grants read, write, and ping access to hooks in public or private repositories.</li>
2685+
<li>
2686+
<code>admin:repo_hook</code> grants read, write, ping, and delete access to hooks in public or private repositories.</li>
2687+
</ul>
2688+
2689+
<p>As always, if you have any questions or feedback, <a href="https://github.com/contact?form%5Bsubject%5D=API+repo+hook+scopes">get in touch</a>.</p>
26822690

2683-
<p>We also added a <a href="/v3/repos/hooks/#ping-a-hook">ping endpoint</a> to the hooks API.
2684-
By using ping instead of <a href="/v3/repos/hooks/#test-a-push-hook">test</a>, you can ensure
2685-
you won’t be limited by the <code>push</code> event requirement that the test endpoint has.</p>
26862691

26872692
</div>
26882693

2689-
<div class="change" id="/changes/2014-02-10-repo-hook-scopes/">
2694+
<div class="change" id="/changes/2014-2-10-ping-event-for-webhooks/">
26902695
<h2 class="title">
2691-
<a href="/changes/2014-02-10-repo-hook-scopes/">New scopes for managing repository hooks</a>
2696+
<a href="/changes/2014-2-10-ping-event-for-webhooks/">Ping Event for Webhooks</a>
26922697
</h2>
26932698

26942699
<div class="meta">
@@ -2699,28 +2704,23 @@ <h2 class="title">
26992704

27002705
</li>
27012706
<li class="who_when">
2702-
<img height="16" width="16" src="https://github.com/pengwynn.png" alt="Avatar for pengwynn">
2703-
<a href="https://github.com/pengwynn">pengwynn</a>
2707+
<img height="16" width="16" src="https://github.com/kdaigle.png" alt="Avatar for kdaigle">
2708+
<a href="https://github.com/kdaigle">kdaigle</a>
27042709
</li>
27052710
</ul>
27062711
</div>
27072712

2708-
<p>Many third party services need to set up <a href="http://developer.github.com/v3/repos/hooks/">hooks</a> in order to act upon events
2709-
in your repositories. Today, we’ve introduced three new <a href="http://developer.github.com/v3/oauth/#scopes">scopes</a> that provide
2710-
more granular access to your repository hooks without allowing access to your
2711-
repository contents:</p>
2712-
2713-
<ul>
2714-
<li>
2715-
<code>read:repo_hook</code> grants read and ping access to hooks in public or private repositories.</li>
2716-
<li>
2717-
<code>write:repo_hook</code> grants read, write, and ping access to hooks in public or private repositories.</li>
2718-
<li>
2719-
<code>admin:repo_hook</code> grants read, write, ping, and delete access to hooks in public or private repositories.</li>
2720-
</ul>
2713+
<p>With the release of our <a href="https://github.com/blog/1778-webhooks-level-up">new webhook UI</a>, we included a new
2714+
<a href="/webhooks/#ping-event">ping event</a> that webhooks will receive. When you
2715+
create a new webhook, we will send this event as an initial test of the webhook.</p>
27212716

2722-
<p>As always, if you have any questions or feedback, <a href="https://github.com/contact?form%5Bsubject%5D=API+repo+hook+scopes">get in touch</a>.</p>
2717+
<p>The ping is only informational, doesn’t need to be responded to in a specific way,
2718+
and nothing bad will happen if you respond with an error. It’s just a quick
2719+
“hello world” to let you know you set everything up correctly.</p>
27232720

2721+
<p>We also added a <a href="/v3/repos/hooks/#ping-a-hook">ping endpoint</a> to the hooks API.
2722+
By using ping instead of <a href="/v3/repos/hooks/#test-a-push-hook">test</a>, you can ensure
2723+
you won’t be limited by the <code>push</code> event requirement that the test endpoint has.</p>
27242724

27252725
</div>
27262726

@@ -3687,9 +3687,9 @@ <h2 class="title">
36873687

36883688
</div>
36893689

3690-
<div class="change" id="/changes/2013-05-06-repository-stats/">
3690+
<div class="change" id="/changes/2013-05-06-create-update-delete-individual-files/">
36913691
<h2 class="title">
3692-
<a href="/changes/2013-05-06-repository-stats/">Repository Statistics</a>
3692+
<a href="/changes/2013-05-06-create-update-delete-individual-files/">Create, update, and delete individual files</a>
36933693
</h2>
36943694

36953695
<div class="meta">
@@ -3700,33 +3700,25 @@ <h2 class="title">
37003700

37013701
</li>
37023702
<li class="who_when">
3703-
<img height="16" width="16" src="https://github.com/Caged.png" alt="Avatar for Caged">
3704-
<a href="https://github.com/Caged">Caged</a>
3703+
<img height="16" width="16" src="https://github.com/ymendel.png" alt="Avatar for ymendel">
3704+
<a href="https://github.com/ymendel">ymendel</a>
37053705
</li>
37063706
</ul>
37073707
</div>
37083708

3709-
<p>Today we’re happy to open our <a href="/v3/repos/statistics">Repository Statistics API</a> to everyone. We’re using
3710-
repository statistics to power <a href="https://github.com/github/linguist/graphs">our graphs</a>,
3711-
but we can’t wait to see what others can do with this information.</p>
3712-
3713-
<p>Starting today, these resources are available to you:</p>
3709+
<p>We’re following in the footsteps of GitHub.com’s ability to <a href="https://github.com/blog/143-inline-file-editing">edit</a> and
3710+
<a href="https://github.com/blog/1327-creating-files-on-github">create</a> files in your web browser. Starting today, the
3711+
<a href="/v3/repos/contents/">Repository Contents API</a> will let you easily <a href="/v3/repos/contents/#create-a-file">create</a>, <a href="/v3/repos/contents/#update-a-file">update</a>, and even
3712+
<a href="/v3/repos/contents/#delete-a-file">delete</a> individual files.</p>
37143713

3715-
<ul>
3716-
<li><strong><a href="/v3/repos/statistics/#contributors">Contributors</a></strong></li>
3717-
<li><strong><a href="/v3/repos/statistics/#commit-activity">Commit Activity</a></strong></li>
3718-
<li><strong><a href="/v3/repos/statistics/#code-frequency">Code Frequency</a></strong></li>
3719-
<li><strong><a href="/v3/repos/statistics/#participation">Participation</a></strong></li>
3720-
<li><strong><a href="/v3/repos/statistics/#punch-card">Punch Card</a></strong></li>
3721-
</ul>
3714+
<p>Happy editing!</p>
37223715

3723-
<p>Enjoy!</p>
37243716

37253717
</div>
37263718

3727-
<div class="change" id="/changes/2013-05-06-create-update-delete-individual-files/">
3719+
<div class="change" id="/changes/2013-05-06-repository-stats/">
37283720
<h2 class="title">
3729-
<a href="/changes/2013-05-06-create-update-delete-individual-files/">Create, update, and delete individual files</a>
3721+
<a href="/changes/2013-05-06-repository-stats/">Repository Statistics</a>
37303722
</h2>
37313723

37323724
<div class="meta">
@@ -3737,19 +3729,27 @@ <h2 class="title">
37373729

37383730
</li>
37393731
<li class="who_when">
3740-
<img height="16" width="16" src="https://github.com/ymendel.png" alt="Avatar for ymendel">
3741-
<a href="https://github.com/ymendel">ymendel</a>
3732+
<img height="16" width="16" src="https://github.com/Caged.png" alt="Avatar for Caged">
3733+
<a href="https://github.com/Caged">Caged</a>
37423734
</li>
37433735
</ul>
37443736
</div>
37453737

3746-
<p>We’re following in the footsteps of GitHub.com’s ability to <a href="https://github.com/blog/143-inline-file-editing">edit</a> and
3747-
<a href="https://github.com/blog/1327-creating-files-on-github">create</a> files in your web browser. Starting today, the
3748-
<a href="/v3/repos/contents/">Repository Contents API</a> will let you easily <a href="/v3/repos/contents/#create-a-file">create</a>, <a href="/v3/repos/contents/#update-a-file">update</a>, and even
3749-
<a href="/v3/repos/contents/#delete-a-file">delete</a> individual files.</p>
3738+
<p>Today we’re happy to open our <a href="/v3/repos/statistics">Repository Statistics API</a> to everyone. We’re using
3739+
repository statistics to power <a href="https://github.com/github/linguist/graphs">our graphs</a>,
3740+
but we can’t wait to see what others can do with this information.</p>
37503741

3751-
<p>Happy editing!</p>
3742+
<p>Starting today, these resources are available to you:</p>
3743+
3744+
<ul>
3745+
<li><strong><a href="/v3/repos/statistics/#contributors">Contributors</a></strong></li>
3746+
<li><strong><a href="/v3/repos/statistics/#commit-activity">Commit Activity</a></strong></li>
3747+
<li><strong><a href="/v3/repos/statistics/#code-frequency">Code Frequency</a></strong></li>
3748+
<li><strong><a href="/v3/repos/statistics/#participation">Participation</a></strong></li>
3749+
<li><strong><a href="/v3/repos/statistics/#punch-card">Punch Card</a></strong></li>
3750+
</ul>
37523751

3752+
<p>Enjoy!</p>
37533753

37543754
</div>
37553755

v3/activity/starring/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ <h3 id="response-1">Response</h3>
183183
<span class="s2">"full_name"</span><span class="p">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
184184
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
185185
<span class="s2">"private"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
186-
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
186+
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
187187
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://api.github.com/repos/octocat/Hello-World"</span><span class="p">,</span>
188188
<span class="s2">"html_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World"</span><span class="p">,</span>
189189
<span class="s2">"clone_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World.git"</span><span class="p">,</span>
@@ -256,7 +256,7 @@ <h3 id="response-2">Response</h3>
256256
<span class="s2">"full_name"</span><span class="p">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
257257
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
258258
<span class="s2">"private"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
259-
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
259+
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
260260
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://api.github.com/repos/octocat/Hello-World"</span><span class="p">,</span>
261261
<span class="s2">"html_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World"</span><span class="p">,</span>
262262
<span class="s2">"clone_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World.git"</span><span class="p">,</span>

v3/activity/watching/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ <h3 id="response-1">Response</h3>
161161
<span class="s2">"full_name"</span><span class="p">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
162162
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
163163
<span class="s2">"private"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
164-
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
164+
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
165165
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://api.github.com/repos/octocat/Hello-World"</span><span class="p">,</span>
166166
<span class="s2">"html_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World"</span><span class="p">,</span>
167167
<span class="s2">"clone_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World.git"</span><span class="p">,</span>

v3/enterprise/search_indexing/index.html

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ <h2 id="queue-an-indexing-job">Queue an indexing job</h2>
7070
<pre><code>POST /staff/indexing_jobs
7171
</code></pre>
7272

73-
<h3 id="parameters">Parameters</h3>
73+
<h3 id="input">Input</h3>
7474

7575
<table>
7676
<thead>
@@ -131,6 +131,12 @@ <h3 id="parameters">Parameters</h3>
131131
</tbody>
132132
</table>
133133

134+
<h3 id="example">Example</h3>
135+
136+
<pre class="terminal">
137+
$ curl -u jwatson -X POST -H "Content-Type: application/json" -d '{"target": "kansaichris/japaning"}' "http://<em>hostname</em>/api/v3/staff/indexing_jobs"
138+
</pre>
139+
134140
<h3 id="response">Response</h3>
135141

136142
<pre class="headers"><code>Status: 202 Accepted
@@ -141,15 +147,6 @@ <h3 id="response">Response</h3>
141147
<span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Repository 'kansaichris/japaning' has been added to the indexing queue"</span>
142148
<span class="p">}</span></code></pre>
143149

144-
<h3 id="example">Example</h3>
145-
146-
<pre class="terminal">
147-
$ curl -u jwatson -X POST "http://<em>hostname</em>/api/v3/staff/indexing_jobs?target=jwatson%2Flaughing-robot"
148-
{
149-
"message": "Repository \"jwatson/laughing-robot\" has been added to the indexing queue"
150-
}
151-
</pre>
152-
153150
</div>
154151

155152
<div id="js-sidebar" class="sidebar-shell">

v3/orgs/teams/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -623,7 +623,7 @@ <h3 id="response-9">Response</h3>
623623
<span class="s2">"full_name"</span><span class="p">:</span> <span class="s2">"octocat/Hello-World"</span><span class="p">,</span>
624624
<span class="s2">"description"</span><span class="p">:</span> <span class="s2">"This your first repo!"</span><span class="p">,</span>
625625
<span class="s2">"private"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
626-
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
626+
<span class="s2">"fork"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
627627
<span class="s2">"url"</span><span class="p">:</span> <span class="s2">"https://api.github.com/repos/octocat/Hello-World"</span><span class="p">,</span>
628628
<span class="s2">"html_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World"</span><span class="p">,</span>
629629
<span class="s2">"clone_url"</span><span class="p">:</span> <span class="s2">"https://github.com/octocat/Hello-World.git"</span><span class="p">,</span>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy