Skip to content

Commit ca3fa25

Browse files
mgriffinmgriffin
committed
Merge pull request github#1062 from github/enterprise-backport-1461682932
Backport platform documentation for 2.0
2 parents f70f7c8 + 53dea5c commit ca3fa25

File tree

9 files changed

+252
-276
lines changed

9 files changed

+252
-276
lines changed

‎enterprise/2.0/search/search-index.json‎

Lines changed: 89 additions & 89 deletions
Large diffs are not rendered by default.

‎enterprise/2.0/v3/activity/events/types/index.html‎

Lines changed: 69 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ <h3>
540540
<h2>
541541
<a id="deploymentevent" class="anchor" href="#deploymentevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>DeploymentEvent</h2>
542542
<p>Represents a <a href="/enterprise/2.0/v3/repos/deployments/#list-deployments">deployment</a>.</p>
543-
<p>Events of this type are not visible in timelines, they are only used to trigger hooks.</p>
543+
<p>Events of this type are not visible in timelines. These events are only used to trigger hooks.</p>
544544
<h3>
545545
<a id="events-api-payload-3" class="anchor" href="#events-api-payload-3" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
546546
<table>
@@ -738,7 +738,7 @@ <h3>
738738
<h2>
739739
<a id="deploymentstatusevent" class="anchor" href="#deploymentstatusevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>DeploymentStatusEvent</h2>
740740
<p>Represents a <a href="/enterprise/2.0/v3/repos/deployments/#list-deployment-statuses">deployment status</a>.</p>
741-
<p>Events of this type are not visible in timelines, they are only used to trigger hooks.</p>
741+
<p>Events of this type are not visible in timelines. These events are only used to trigger hooks.</p>
742742
<h3>
743743
<a id="events-api-payload-4" class="anchor" href="#events-api-payload-4" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
744744
<table>
@@ -1450,7 +1450,7 @@ <h3>
14501450
</span></code></pre>
14511451
<h2>
14521452
<a id="issuecommentevent" class="anchor" href="#issuecommentevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>IssueCommentEvent</h2>
1453-
<p>Triggered when an <a href="/enterprise/2.0/v3/issues/comments/">issue comment</a> is created on an issue or pull request.</p>
1453+
<p>Triggered when an <a href="/enterprise/2.0/v3/issues/comments/">issue comment</a> is created, edited, or deleted.</p>
14541454
<h3>
14551455
<a id="events-api-payload-11" class="anchor" href="#events-api-payload-11" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
14561456
<table>
@@ -1463,7 +1463,17 @@ <h3>
14631463
<tr>
14641464
<td><code>action</code></td>
14651465
<td><code>string</code></td>
1466-
<td>The action that was performed on the comment. Currently, can only be "created".</td>
1466+
<td>The action that was performed on the comment. Can be one of "created", "edited", or "deleted".</td>
1467+
</tr>
1468+
<tr>
1469+
<td><code>changes</code></td>
1470+
<td><code>object</code></td>
1471+
<td>The changes to the comment if the action was "edited".</td>
1472+
</tr>
1473+
<tr>
1474+
<td><code>changes[body][from]</code></td>
1475+
<td><code>string</code></td>
1476+
<td>The previous version of the body if the action was "edited".</td>
14671477
</tr>
14681478
<tr>
14691479
<td><code>issue</code></td>
@@ -1667,7 +1677,7 @@ <h3>
16671677
</span></code></pre>
16681678
<h2>
16691679
<a id="issuesevent" class="anchor" href="#issuesevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>IssuesEvent</h2>
1670-
<p>Triggered when an <a href="/enterprise/2.0/v3/issues">issue</a> is assigned, unassigned, labeled, unlabeled, opened, closed, or reopened.</p>
1680+
<p>Triggered when an <a href="/enterprise/2.0/v3/issues">issue</a> is assigned, unassigned, labeled, unlabeled, opened, edited, closed, or reopened.</p>
16711681
<h3>
16721682
<a id="events-api-payload-12" class="anchor" href="#events-api-payload-12" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
16731683
<table>
@@ -1680,14 +1690,29 @@ <h3>
16801690
<tr>
16811691
<td><code>action</code></td>
16821692
<td><code>string</code></td>
1683-
<td>The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "closed", or "reopened".</td>
1693+
<td>The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "edited", "closed", or "reopened".</td>
16841694
</tr>
16851695
<tr>
16861696
<td><code>issue</code></td>
16871697
<td><code>object</code></td>
16881698
<td>The <a href="/enterprise/2.0/v3/issues">issue</a> itself.</td>
16891699
</tr>
16901700
<tr>
1701+
<td><code>changes</code></td>
1702+
<td><code>object</code></td>
1703+
<td>The changes to the issue if the action was "edited".</td>
1704+
</tr>
1705+
<tr>
1706+
<td><code>changes[title][from]</code></td>
1707+
<td><code>string</code></td>
1708+
<td>The previous version of the title if the action was "edited".</td>
1709+
</tr>
1710+
<tr>
1711+
<td><code>changes[body][from]</code></td>
1712+
<td><code>string</code></td>
1713+
<td>The previous version of the body if the action was "edited".</td>
1714+
</tr>
1715+
<tr>
16911716
<td><code>assignee</code></td>
16921717
<td><code>object</code></td>
16931718
<td>The optional user who was assigned or unassigned from the issue.</td>
@@ -2020,7 +2045,7 @@ <h3>
20202045
<h2>
20212046
<a id="membershipevent" class="anchor" href="#membershipevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>MembershipEvent</h2>
20222047
<p>Triggered when a user is added or removed from a team.</p>
2023-
<p>Events of this type are not visible in timelines, they are only used to trigger organization webhooks.</p>
2048+
<p>Events of this type are not visible in timelines. These events are only used to trigger hooks.</p>
20242049
<h3>
20252050
<a id="events-api-payload-14" class="anchor" href="#events-api-payload-14" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
20262051
<table>
@@ -2123,7 +2148,7 @@ <h2>
21232148
<a id="pagebuildevent" class="anchor" href="#pagebuildevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>PageBuildEvent</h2>
21242149
<p>Represents an attempted build of a GitHub Pages site, whether successful or not.</p>
21252150
<p>Triggered on push to a GitHub Pages enabled branch (<code>gh-pages</code> for project pages, <code>master</code> for user and organization pages).</p>
2126-
<p>Events of this type are not visible in timelines, they are only used to trigger hooks.</p>
2151+
<p>Events of this type are not visible in timelines. These events are only used to trigger hooks.</p>
21272152
<h3>
21282153
<a id="events-api-payload-15" class="anchor" href="#events-api-payload-15" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
21292154
<table>
@@ -2404,7 +2429,7 @@ <h3>
24042429
</span></code></pre>
24052430
<h2>
24062431
<a id="pullrequestevent" class="anchor" href="#pullrequestevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>PullRequestEvent</h2>
2407-
<p>Triggered when a <a href="/enterprise/2.0/v3/pulls">pull request</a> is assigned, unassigned, labeled, unlabeled, opened, closed, reopened, or synchronized.</p>
2432+
<p>Triggered when a <a href="/enterprise/2.0/v3/pulls">pull request</a> is assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, or synchronized.</p>
24082433
<h3>
24092434
<a id="events-api-payload-17" class="anchor" href="#events-api-payload-17" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
24102435
<table>
@@ -2417,14 +2442,29 @@ <h3>
24172442
<tr>
24182443
<td><code>action</code></td>
24192444
<td><code>string</code></td>
2420-
<td>The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "closed", or "reopened", or "synchronize". If the action is "closed" and the <code>merged</code> key is <code>false</code>, the pull request was closed with unmerged commits. If the action is "closed" and the <code>merged</code> key is <code>true</code>, the pull request was merged.</td>
2445+
<td>The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "edited", "closed", or "reopened", or "synchronize". If the action is "closed" and the <code>merged</code> key is <code>false</code>, the pull request was closed with unmerged commits. If the action is "closed" and the <code>merged</code> key is <code>true</code>, the pull request was merged.</td>
24212446
</tr>
24222447
<tr>
24232448
<td><code>number</code></td>
24242449
<td><code>integer</code></td>
24252450
<td>The pull request number.</td>
24262451
</tr>
24272452
<tr>
2453+
<td><code>changes</code></td>
2454+
<td><code>object</code></td>
2455+
<td>The changes to the comment if the action was "edited".</td>
2456+
</tr>
2457+
<tr>
2458+
<td><code>changes[title][from]</code></td>
2459+
<td><code>string</code></td>
2460+
<td>The previous version of the title if the action was "edited".</td>
2461+
</tr>
2462+
<tr>
2463+
<td><code>changes[body][from]</code></td>
2464+
<td><code>string</code></td>
2465+
<td>The previous version of the body if the action was "edited".</td>
2466+
</tr>
2467+
<tr>
24282468
<td><code>pull_request</code></td>
24292469
<td><code>object</code></td>
24302470
<td>The <a href="/enterprise/2.0/v3/pulls">pull request</a> itself.</td>
@@ -2851,7 +2891,7 @@ <h3>
28512891
</span></code></pre>
28522892
<h2>
28532893
<a id="pullrequestreviewcommentevent" class="anchor" href="#pullrequestreviewcommentevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>PullRequestReviewCommentEvent</h2>
2854-
<p>Triggered when a <a href="/enterprise/2.0/v3/pulls/comments">comment is created on a portion of the unified diff</a> of a pull request.</p>
2894+
<p>Triggered when a <a href="/enterprise/2.0/v3/pulls/comments">comment on a Pull Request's unified diff</a> is created, edited, or deleted (in the Files Changed tab).</p>
28552895
<h3>
28562896
<a id="events-api-payload-18" class="anchor" href="#events-api-payload-18" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
28572897
<table>
@@ -2864,7 +2904,17 @@ <h3>
28642904
<tr>
28652905
<td><code>action</code></td>
28662906
<td><code>string</code></td>
2867-
<td>The action that was performed on the comment. Currently, can only be "created".</td>
2907+
<td>The action that was performed on the comment. Can be one of <code>created</code>, <code>edited</code>, or <code>deleted</code>.</td>
2908+
</tr>
2909+
<tr>
2910+
<td><code>changes</code></td>
2911+
<td><code>object</code></td>
2912+
<td>The changes to the comment if the action was "edited".</td>
2913+
</tr>
2914+
<tr>
2915+
<td><code>changes[body][from]</code></td>
2916+
<td><code>string</code></td>
2917+
<td>The previous version of the body if the action was "edited".</td>
28682918
</tr>
28692919
<tr>
28702920
<td><code>pull_request</code></td>
@@ -3429,6 +3479,7 @@ <h3>
34293479
</span><span class="nt">"commits"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
34303480
</span><span class="p">{</span><span class="w">
34313481
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c"</span><span class="p">,</span><span class="w">
3482+
</span><span class="nt">"tree_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f9d2a07e9488b91af2641b26b9407fe22a451433"</span><span class="p">,</span><span class="w">
34323483
</span><span class="nt">"distinct"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
34333484
</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Update README.md"</span><span class="p">,</span><span class="w">
34343485
</span><span class="nt">"timestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-05-05T19:40:15-04:00"</span><span class="p">,</span><span class="w">
@@ -3454,6 +3505,7 @@ <h3>
34543505
</span><span class="p">],</span><span class="w">
34553506
</span><span class="nt">"head_commit"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
34563507
</span><span class="nt">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c"</span><span class="p">,</span><span class="w">
3508+
</span><span class="nt">"tree_id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f9d2a07e9488b91af2641b26b9407fe22a451433"</span><span class="p">,</span><span class="w">
34573509
</span><span class="nt">"distinct"</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span><span class="w">
34583510
</span><span class="nt">"message"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Update README.md"</span><span class="p">,</span><span class="w">
34593511
</span><span class="nt">"timestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2015-05-05T19:40:15-04:00"</span><span class="p">,</span><span class="w">
@@ -3754,8 +3806,8 @@ <h3>
37543806
</span></code></pre>
37553807
<h2>
37563808
<a id="repositoryevent" class="anchor" href="#repositoryevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>RepositoryEvent</h2>
3757-
<p>Triggered when a repository is created.</p>
3758-
<p>Events of this type are not visible in timelines, they are only used to trigger organization webhooks.</p>
3809+
<p>Triggered when a repository is created, deleted, made public, or made private.</p>
3810+
<p>Events of this type are not visible in timelines. These events are only used to trigger hooks.</p>
37593811
<h3>
37603812
<a id="events-api-payload-21" class="anchor" href="#events-api-payload-21" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
37613813
<table>
@@ -3768,12 +3820,12 @@ <h3>
37683820
<tr>
37693821
<td><code>action</code></td>
37703822
<td><code>string</code></td>
3771-
<td>The action that was performed. Currently, can only be "created".</td>
3823+
<td>The action that was performed. This can be one of <code>created</code>, <code>deleted</code>, <code>publicized</code>, or <code>privatized</code>.</td>
37723824
</tr>
37733825
<tr>
37743826
<td><code>repository</code></td>
37753827
<td><code>object</code></td>
3776-
<td>The <a href="/enterprise/2.0/v3/repos/">repository</a> that was created.</td>
3828+
<td>The <a href="/enterprise/2.0/v3/repos/">repository</a> itself.</td>
37773829
</tr>
37783830
</tbody>
37793831
</table>
@@ -3905,7 +3957,7 @@ <h3>
39053957
<h2>
39063958
<a id="statusevent" class="anchor" href="#statusevent" aria-hidden="true"><span class="octicon octicon-link"></span></a>StatusEvent</h2>
39073959
<p>Triggered when the status of a Git commit changes.</p>
3908-
<p>Events of this type are not visible in timelines, they are only used to trigger hooks.</p>
3960+
<p>Events of this type are not visible in timelines. These events are only used to trigger hooks.</p>
39093961
<h3>
39103962
<a id="events-api-payload-22" class="anchor" href="#events-api-payload-22" aria-hidden="true"><span class="octicon octicon-link"></span></a>Events API payload</h3>
39113963
<table>

0 commit comments

Comments
 (0)