Skip to content
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commit 670b940

Browse files
jtrent238jtrent238
committed
Merge pull request #1 from github/master
update
2 parents ead0f50 + b0e9b96 commit 670b940

19 files changed

+793
-37
lines changed

‎Rakefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ end
3636
desc "Run the HTML-Proofer"
3737
task :run_proofer do
3838
require 'html-proofer'
39-
ignored_links = [%r{www.w3.org}, /api\.github\.com/]
39+
ignored_links = [%r{www.w3.org}, /api\.github\.com/, /import\.github\.com/]
4040
# swap versionless Enterprise articles with versioned paths
4141
url_swap = {
4242
%r{help.github.com/enterprise/admin/} => "help.github.com/enterprise/#{config[:versions][0]}/admin/",

‎content/changes/2016-05-03-source-import-api-enhancements-for-working-with-git-lfs.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Source Import API enhancements for working with Git LFS
3+
author_name: lizzhale
4+
---
5+
6+
Today we're introducing enhancements to the [Source Import API][docs] to support importing repositories with files larger than 100MB.
7+
8+
**Changes to parameters for starting an import**
9+
10+
[Starting an import][start-an-import] no longer requires a `vcs` parameter. Please be aware that without this parameter, the import job will take additional time to detect the vcs type before beginning the import. This detection step will be reflected in the response.
11+
12+
**New methods**
13+
14+
We've added 3 new methods that will enable API consumers to:
15+
16+
* [update][update-existing-import] the authentication or project choice for an import. If no parameters are provided during the request, the import will be restarted. Please note that this is a **breaking change**. Updating authentication for the originating URL is no longer supported through the [start an import][start-an-import] method. Please update your applications to use the new method.
17+
18+
* [set their preference][set-git-lfs-preference] for using Git LFS to import files larger than 100MB.
19+
20+
* [list all the files larger than 100MB][get-large-files] that were found during the import.
21+
22+
**New attributes for Git LFS**
23+
24+
Several new response attributes (`use_lfs`, `has_large_files`, `large_files_size`, `large_files`) were added to provide details regarding the large files found during the import. You can read more about the attributes [here][git-lfs-related-fields].
25+
26+
As before, to access the API during the preview period, you must provide a custom [media type][media-type] in the `Accept` header:
27+
28+
application/vnd.github.barred-rock-preview
29+
30+
For more information, see the [Source Import API documentation][docs], and if you have any questions or feedback, please [let us know][contact].
31+
32+
33+
[docs]: /v3/migration/source_imports/
34+
[start-an-import]: /v3/migration/source_imports/#start-an-import
35+
[update-existing-import]: /v3/migration/source_imports/#update-existing-import
36+
[set-git-lfs-preference]: /v3/migration/source_imports/#set-git-lfs-preference
37+
[get-large-files]: /v3/migration/source_imports/#get-large-files
38+
[git-lfs-related-fields]: /v3/migration/source_imports/#git-lfs-related-fields
39+
[media-type]: /v3/media
40+
[contact]: https://github.com/contact?form%5Bsubject%5D=Source+Import+API

‎content/changes/2016-05-12-reactions-api-preview.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Preview support for Reactions API
3+
author_name: kneemer
4+
---
5+
6+
GitHub recently added [Reactions to Pull Requests, Issues, and Comments][reactions-blog-post] to help people express their feelings more simply and effectively in conversations. We are adding endpoints for Reactions so that you can now react and unreact via the API. You can enable these changes during the preview period by providing a custom [media type][media-type] in the `Accept` header:
7+
8+
application/vnd.github.squirrel-girl-preview
9+
10+
For example:
11+
12+
To view reactions on an issue:
13+
14+
``` command-line
15+
$ curl "https://api.github.com/repos/github/hubot/issues/1/reactions" \
16+
-H "Accept: application/vnd.github.squirrel-girl-preview"
17+
```
18+
19+
20+
You can learn more about the new reaction response objects in the updated [Commit comment][commit-comment-doc], [Issue][issue-doc], [Issue comment][issue-comment-doc], and [Review Comment][review-comment-doc] documentation. There is also new [Reaction][reaction-doc] documentation.
21+
22+
During the preview period, we may change aspects of these APIs based on developer feedback. We will announce the changes here on the developer blog, but we will not provide advance notice.
23+
24+
If you have any questions or feedback, please [let us know][contact].
25+
26+
[media-type]: /v3/media
27+
[reaction-doc]: /v3/reactions
28+
[issue-doc]: /v3/issues#preview-period-org-issues
29+
[issue-comment-doc]: /v3/issues/comments#preview-period-issue-comments
30+
[review-comment-doc]: /v3/pulls/comments#preview-period-pull-comments
31+
[commit-comment-doc]: /v3/repos/comments#preview-period-commits-comments
32+
[contact]: https://github.com/contact?form%5Bsubject%5D=Reactions+API+Preview
33+
[reactions-blog-post]: https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments

‎content/v3/activity/events/types.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -239,15 +239,19 @@ Key | Type | Description
239239

240240
## IssueCommentEvent
241241

242+
{% if page.version == 'dotcom' or page.version > 2.6 %}
242243
Triggered when an [issue comment](/v3/issues/comments/) is created, edited, or deleted.
244+
{% else %}
245+
Triggered when an [issue is commented on](/v3/issues/comments/).
246+
{% endif %}
243247

244248
### Events API payload
245249

246250
Key | Type | Description
247251
----|------|-------------
248-
`action`|`string` | The action that was performed on the comment. Can be one of "created", "edited", or "deleted".
252+
`action`|`string` | The action that was performed on the comment. {% if page.version == 'dotcom' or page.version > 2.6 %}Can be one of "created", "edited", or "deleted".
249253
`changes`|`object` | The changes to the comment if the action was "edited".
250-
`changes[body][from]` |`string` | The previous version of the body if the action was "edited".
254+
`changes[body][from]` |`string` | The previous version of the body if the action was "edited".{% else %}Currently, can only be "created".{% endif %}
251255
`issue`|`object` | The [issue](/v3/issues/) the comment belongs to.
252256
`comment`|`object` | The [comment](/v3/issues/comments/) itself.
253257

@@ -261,17 +265,17 @@ Key | Type | Description
261265

262266
## IssuesEvent
263267

264-
Triggered when an [issue](/v3/issues) is assigned, unassigned, labeled, unlabeled, opened, edited, closed, or reopened.
268+
Triggered when an [issue](/v3/issues) is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, or reopened.
265269

266270
### Events API payload
267271

268272
Key | Type | Description
269273
----|------|-------------
270-
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "edited", "closed", or "reopened".
271-
`issue`|`object` | The [issue](/v3/issues) itself.
274+
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", {% if page.version == 'dotcom' or page.version > 2.6 %}"edited", {% endif %}"closed", or "reopened".
275+
`issue`|`object` | The [issue](/v3/issues) itself.{% if page.version == 'dotcom' or page.version > 2.6 %}
272276
`changes`|`object`| The changes to the issue if the action was "edited".
273277
`changes[title][from]`|`string` | The previous version of the title if the action was "edited".
274-
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".
278+
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% endif %}
275279
`assignee`|`object` | The optional user who was assigned or unassigned from the issue.
276280
`label`|`object` | The optional label that was added or removed from the issue.
277281

@@ -363,17 +367,17 @@ Triggered when a private repository is [open sourced](/v3/repos/#edit). Without
363367

364368
## PullRequestEvent
365369

366-
Triggered when a [pull request](/v3/pulls) is assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, or synchronized.
370+
Triggered when a [pull request](/v3/pulls) is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, reopened, or synchronized.
367371

368372
### Events API payload
369373

370374
Key | Type | Description
371375
----|------|-------------
372-
`action`|`string` | 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 `merged` key is `false`, the pull request was closed with unmerged commits. If the action is "closed" and the `merged` key is `true`, the pull request was merged.
373-
`number`|`integer` | The pull request number.
376+
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", {% if page.version == 'dotcom' or page.version > 2.6 %}"edited", {% endif %}"closed", or "reopened", or "synchronize". If the action is "closed" and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is "closed" and the `merged` key is `true`, the pull request was merged.
377+
`number`|`integer` | The pull request number.{% if page.version == 'dotcom' or page.version > 2.6 %}
374378
`changes`|`object`| The changes to the comment if the action was "edited".
375379
`changes[title][from]`|`string` | The previous version of the title if the action was "edited".
376-
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".
380+
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% endif %}
377381
`pull_request`|`object` | The [pull request](/v3/pulls) itself.
378382

379383
### Webhook event name
@@ -386,15 +390,19 @@ Key | Type | Description
386390

387391
## PullRequestReviewCommentEvent
388392

393+
{% if page.version == 'dotcom' or page.version > 2.6 %}
389394
Triggered when a [comment on a Pull Request's unified diff](/v3/pulls/comments) is created, edited, or deleted (in the Files Changed tab).
395+
{% else %}
396+
Triggered when a [Pull Request's unified diff is commented on](/v3/pulls/comments) (in the Files Changed tab).
397+
{% endif %}
390398

391399
### Events API payload
392400

393401
Key | Type | Description
394402
----|------|-------------
395-
`action`|`string` | The action that was performed on the comment. Can be one of `created`, `edited`, or `deleted`.
403+
`action`|`string` | The action that was performed on the comment. {% if page.version == 'dotcom' or page.version > 2.6 %}Can be one of "created", "edited", or "deleted".
396404
`changes`|`object`| The changes to the comment if the action was "edited".
397-
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".
405+
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% else %}Currently, can only be "created".{% endif %}
398406
`pull_request`|`object` | The [pull request](/v3/pulls/) the comment belongs to.
399407
`comment`|`object` | The [comment](/v3/pulls/comments) itself.
400408

@@ -463,15 +471,15 @@ Key | Type | Description
463471

464472
## RepositoryEvent
465473

466-
Triggered when a repository is created, deleted, made public, or made private.
474+
Triggered when a repository is created{% if page.version == 'dotcom' or page.version > 2.6 %}, deleted, made public, or made private{% endif %}.
467475

468-
Events of this type are not visible in timelines. These events are only used to trigger hooks.
476+
Events of this type are not visible in timelines. These events are only used to trigger {% if page.version != 'dotcom' and page.version <= 2.6 %}organization {% endif %}hooks.
469477

470478
### Events API payload
471479

472480
Key | Type | Description
473481
----|------|-------------
474-
`action` |`string` | The action that was performed. This can be one of `created`, `deleted`, `publicized`, or `privatized`.
482+
`action` |`string` | The action that was performed. {% if page.version == 'dotcom' or page.version > 2.6 %}This can be one of "created", "deleted", "publicized", or "privatized".{% else %}Currently, can only be "created".{% endif %}
475483
`repository`|`object` | The [repository](/v3/repos/) itself.
476484

477485
### Webhook event name

‎content/v3/issues.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,26 @@ Name | Type | Description
4949
<%= headers 200, :pagination => default_pagination_rels %>
5050
<%= json(:issue) { |h| [h] } %>
5151

52+
{% if page.version == 'dotcom' %}
53+
#### Reactions summary
54+
55+
{{#tip}}
56+
57+
<a name="preview-period-org-issues"></a>
58+
59+
An additional `reactions` object in the issue payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice.
60+
Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details.
61+
62+
To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
63+
64+
application/vnd.github.squirrel-girl-preview
65+
66+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions.
67+
68+
{{/tip}}
69+
<%= json :issue_reaction_summary %>
70+
{% endif %}
71+
5272
## List issues for a repository
5373

5474
<%= fetch_content(:prs_as_issues) %>
@@ -74,6 +94,27 @@ Name | Type | Description
7494
<%= headers 200, :pagination => default_pagination_rels %>
7595
<%= json(:issue) { |h| [h] } %>
7696

97+
{% if page.version == 'dotcom' %}
98+
#### Reactions summary
99+
100+
{{#tip}}
101+
102+
<a name="preview-period-repo-issues"></a>
103+
104+
An additional `reactions` object in the issue payload is currently available for developers to preview.
105+
During the preview period, the APIs may change without advance notice.
106+
Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details.
107+
108+
To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
109+
110+
application/vnd.github.squirrel-girl-preview
111+
112+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions.
113+
114+
{{/tip}}
115+
<%= json :issue_reaction_summary %>
116+
{% endif %}
117+
77118
## Get a single issue
78119

79120
<%= fetch_content(:prs_as_issues) %>
@@ -85,6 +126,27 @@ Name | Type | Description
85126
<%= headers 200 %>
86127
<%= json :full_issue %>
87128

129+
{% if page.version == 'dotcom' %}
130+
#### Reactions summary
131+
132+
{{#tip}}
133+
134+
<a name="preview-period-issue"></a>
135+
136+
An additional `reactions` object in the issue payload is currently available for developers to preview.
137+
During the preview period, the APIs may change without advance notice.
138+
Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details.
139+
140+
To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
141+
142+
application/vnd.github.squirrel-girl-preview
143+
144+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions.
145+
146+
{{/tip}}
147+
<%= json :issue_reaction_summary %>
148+
{% endif %}
149+
88150
## Create an issue
89151

90152
Any user with pull access to a repository can create an issue.

‎content/v3/issues/comments.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,27 @@ Name | Type | Description
3030
<%= headers 200, :pagination => default_pagination_rels %>
3131
<%= json(:issue_comment) { |h| [h] } %>
3232

33+
{% if page.version == 'dotcom' %}
34+
#### Reactions summary
35+
36+
{{#tip}}
37+
38+
<a name="preview-period-issue-comments"></a>
39+
40+
An additional `reactions` object in the issue comment payload is currently available for developers to preview.
41+
During the preview period, the APIs may change without advance notice.
42+
Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details.
43+
44+
To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
45+
46+
application/vnd.github.squirrel-girl-preview
47+
48+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions.
49+
50+
{{/tip}}
51+
<%= json :issue_comment_reaction_summary %>
52+
{% endif %}
53+
3354
## List comments in a repository
3455

3556
GET /repos/:owner/:repo/issues/comments
@@ -50,6 +71,27 @@ Name | Type | Description
5071
<%= headers 200 %>
5172
<%= json(:issue_comment) { |h| [h] } %>
5273

74+
{% if page.version == 'dotcom' %}
75+
#### Reactions summary
76+
77+
{{#tip}}
78+
79+
<a name="preview-period-issues-comments"></a>
80+
81+
An additional `reactions` object in the issue comment payload is currently available for developers to preview.
82+
During the preview period, the APIs may change without advance notice.
83+
Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details.
84+
85+
To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
86+
87+
application/vnd.github.squirrel-girl-preview
88+
89+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions.
90+
91+
{{/tip}}
92+
<%= json :issue_comment_reaction_summary %>
93+
{% endif %}
94+
5395
## Get a single comment
5496

5597
GET /repos/:owner/:repo/issues/comments/:id
@@ -59,6 +101,27 @@ Name | Type | Description
59101
<%= headers 200, :pagination => default_pagination_rels %>
60102
<%= json :issue_comment %>
61103

104+
{% if page.version == 'dotcom' %}
105+
#### Reactions summary
106+
107+
{{#tip}}
108+
109+
<a name="preview-period-issue-comment"></a>
110+
111+
An additional `reactions` object in the issue comment payload is currently available for developers to preview.
112+
During the preview period, the APIs may change without advance notice.
113+
Please see the [blog post](/changes/2016-05-12-reactions-api-preview) for full details.
114+
115+
To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:
116+
117+
application/vnd.github.squirrel-girl-preview
118+
119+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](/v3/reactions) reactions.
120+
121+
{{/tip}}
122+
<%= json :issue_comment_reaction_summary %>
123+
{% endif %}
124+
62125
## Create a comment
63126

64127
POST /repos/:owner/:repo/issues/:number/comments

‎content/v3/issues/events.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ determine who should be notified of comments.
2525
<dt>commit_id</dt>
2626
<dd>The String SHA of a commit that referenced this Issue</dd>
2727

28+
<dt>commit_url</dt>
29+
<dd>The GitHub API link to a commit that referenced this Issue</dd>
30+
2831
<dt>event</dt>
2932
<dd>Identifies the actual type of Event that occurred.</dd>
3033

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