Skip to content

Commit 11c14ac

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent ed9d74a commit 11c14ac

File tree

2 files changed

+113
-86
lines changed

2 files changed

+113
-86
lines changed

content/v3/issues/events.md

Lines changed: 65 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -12,96 +12,100 @@ determine who should be notified of comments.
1212

1313
### Attributes
1414

15-
id
16-
: The Integer ID of the event.
15+
<dl>
16+
<dt>id</dt>
17+
<dd>The Integer ID of the event.</dd>
1718

18-
url
19-
: The API URL for fetching the event.
19+
<dt>url</dt>
20+
<dd>The API URL for fetching the event.</dd>
2021

21-
actor
22-
: Always the User that generated the event.
22+
<dt>actor</dt>
23+
<dd>Always the User that generated the event.</dd>
2324

24-
commit_id
25-
: The String SHA of a commit that referenced this Issue
25+
<dt>commit_id</dt>
26+
<dd>The String SHA of a commit that referenced this Issue</dd>
2627

27-
event
28-
: Identifies the actual type of Event that occurred.
28+
<dt>event</dt>
29+
<dd>Identifies the actual type of Event that occurred.</dd>
2930

30-
created_at
31-
: The timestamp indicating when the event occurred.
31+
<dt>created_at</dt>
32+
<dd>The timestamp indicating when the event occurred.</dd>
3233

33-
label
34-
: The Label object including 'name' and 'color' attributes. Only provided for 'labeled'
35-
and 'unlabeled' events.
34+
<dt>label</dt>
35+
<dd>The Label object including 'name' and 'color' attributes. Only provided for 'labeled'
36+
and 'unlabeled' events.</dd>
3637

37-
assignee
38-
: The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned'
39-
and 'unassigned' events.
38+
<dt>assignee</dt>
39+
<dd>The User object which was assigned to (or unassigned from) this Issue. Only provided for 'assigned' and 'unassigned' events.</dd>
4040

41-
milestone
42-
: The Milestone object including a 'title' attribute. Only provided for 'milestoned' and
43-
'demilestoned' events.
41+
<dt>milestone</dt>
42+
<dd>The Milestone object including a 'title' attribute. Only provided for 'milestoned' and
43+
'demilestoned' events.</dd>
4444

45-
rename
46-
: An object containing rename details including 'from' and 'to' attributes. Only
47-
provided for 'renamed' events.
45+
<dt>rename</dt>
46+
<dd>An object containing rename details including 'from' and 'to' attributes. Only
47+
provided for 'renamed' events.</dd>
48+
</dl>
4849

4950
### Events
5051

51-
closed
52-
: The issue was closed by the actor. When the commit_id is present, it
52+
<dl>
53+
<dt>closed</dt>
54+
<dd>The issue was closed by the actor. When the commit_id is present, it
5355
identifies the commit that closed the issue using "closes / fixes #NN"
54-
syntax.
56+
syntax.</dd>
5557

56-
reopened
57-
: The issue was reopened by the actor.
5858

59-
subscribed
60-
: The actor subscribed to receive notifications for an issue.
59+
<dt>reopened</dt>
60+
<dd>The issue was reopened by the actor.</dd>
6161

62-
merged
63-
: The issue was merged by the actor. The `commit_id` attribute is the SHA1 of
64-
the HEAD commit that was merged.
62+
<dt>subscribed</dt>
63+
<dd>The actor subscribed to receive notifications for an issue.</dd>
6564

66-
referenced
67-
: The issue was referenced from a commit message. The `commit_id` attribute is
68-
the commit SHA1 of where that happened.
65+
<dt>merged</dt>
66+
<dd>The issue was merged by the actor. The `commit_id` attribute is the SHA1 of
67+
the HEAD commit that was merged.</dd>
6968

70-
mentioned
71-
: The actor was @mentioned in an issue body.
69+
<dt>referenced</dt>
70+
<dd>The issue was referenced from a commit message. The `commit_id` attribute is
71+
the commit SHA1 of where that happened.</dd>
7272

73-
assigned
74-
: The issue was assigned to the actor.
73+
<dt>mentioned</dt>
74+
<dd>The actor was @mentioned in an issue body.</dd>
7575

76-
unassigned
77-
: The actor was unassigned from the issue.
76+
<dt>assigned</dt>
77+
<dd>The issue was assigned to the actor.</dd>
7878

79-
labeled
80-
: A label was added to the issue.
79+
<dt>unassigned</dt>
80+
<dd>The actor was unassigned from the issue.</dd>
8181

82-
unlabeled
83-
: A label was removed from the issue.
82+
<dt>labeled</dt>
83+
<dd>A label was added to the issue.</dd>
8484

85-
milestoned
86-
: The issue was added to a milestone.
85+
<dt>unlabeled</dt>
86+
<dd>A label was removed from the issue.</dd>
8787

88-
demilestoned
89-
: The issue was removed from a milestone.
88+
<dt>milestoned</dt>
89+
<dd>The issue was added to a milestone.</dd>
9090

91-
renamed
92-
: The issue title was changed.
91+
<dt>demilestoned</dt>
92+
<dd>The issue was removed from a milestone.</dd>
9393

94-
locked
95-
: The issue was locked by the actor.
94+
<dt>renamed</dt>
95+
<dd>The issue title was changed.</dd>
9696

97-
unlocked
98-
: The issue was unlocked by the actor.
97+
<dt>locked</dt>
98+
<dd>The issue was locked by the actor.</dd>
9999

100-
head_ref_deleted
101-
: The pull request's branch was deleted.
100+
<dt>unlocked</dt>
101+
<dd>The issue was unlocked by the actor.</dd>
102102

103-
head_ref_restored
104-
: The pull request's branch was restored.
103+
<dt>head_ref_deleted</dt>
104+
<dd>The pull request's branch was deleted.</dd>
105+
106+
<dt>head_ref_restored</dt>
107+
<dd>The pull request's branch was restored.</dd>
108+
</dl>
105109

106110
## List events for an issue
107111

@@ -129,4 +133,3 @@ head_ref_restored
129133

130134
<%= headers 200 %>
131135
<%= json :full_issue_event %>
132-

content/v3/versions.md

Lines changed: 48 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -42,84 +42,108 @@ functionality _will be removed_ in the next major version of the API.
4242
The recommendations below will help you prepare your application for the next major version of the API.
4343

4444
1. Method: /gists/:id/fork
45-
: Recommendation: Use **/gists/:id/forks** (plural) instead.
45+
46+
Recommendation: Use **/gists/:id/forks** (plural) instead.
4647

4748
1. Method: /legacy/issues/search/:owner/:repository/:state/:keyword
48-
: Recommendation: Use [v3 Issue Search API](/v3/search/#search-issues) instead.
49+
50+
Recommendation: Use [v3 Issue Search API](/v3/search/#search-issues) instead.
4951

5052
1. Method: /legacy/repos/search/:keyword
51-
: Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead.
53+
54+
Recommendation: Use [v3 Repository Search API](/v3/search/#search-repositories) instead.
5255

5356
1. Method: /legacy/user/search/:keyword
54-
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
57+
58+
Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
5559

5660
1. Method: /legacy/user/email/:email
57-
: Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
61+
62+
Recommendation: Use [v3 User Search API](/v3/search/#search-users) instead.
5863

5964
1. Method: /repos/:owner/:repo/hooks/:id/test
60-
: Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead.
65+
66+
Recommendation: Use **/repos/:owner/:repo/hooks/:id/tests** (plural) instead.
6167

6268
1. Method: /teams/:id/members/:username
63-
: Recommendation: Use [Get Team Membership](/v3/orgs/teams/#get-team-membership), [Add Team Membership](/v3/orgs/teams/#add-team-membership), and [Remove Team Membership](/v3/orgs/teams/#remove-team-membership) instead.
69+
70+
Recommendation: Use [Get Team Membership](/v3/orgs/teams/#get-team-membership), [Add Team Membership](/v3/orgs/teams/#add-team-membership), and [Remove Team Membership](/v3/orgs/teams/#remove-team-membership) instead.
6471

6572
1. Query parameters when POSTing to /repos/:owner/:repo/forks
66-
: Recommendation: Use JSON to POST to this method instead.
73+
74+
Recommendation: Use JSON to POST to this method instead.
6775

6876
1. Query parameter value: Passing "watchers" as the value for the "sort" parameter in a GET request to /repos/:owner/:repo/forks
69-
: Recommendation: Use **stargazers** as the value instead.
77+
78+
Recommendation: Use **stargazers** as the value instead.
7079

7180
1. Pull Request attribute: merge_commit_sha
72-
: Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/).
81+
82+
Recommendation: [Do not use this attribute](/changes/2013-04-25-deprecating-merge-commit-sha/).
7383

7484
1. Rate Limit attribute: rate
75-
: Recommendation: Use **resources["core"]** instead.
85+
86+
Recommendation: Use **resources["core"]** instead.
7687

7788
1. Repository attribute: forks
78-
: Recommendation: Use **forks_count** instead.
89+
90+
Recommendation: Use **forks_count** instead.
7991

8092
1. Repository attribute: master_branch
81-
: Recommendation: Use **default_branch** instead.
93+
94+
Recommendation: Use **default_branch** instead.
8295

8396
1. Repository attribute: open_issues
84-
: Recommendation: Use **open_issues_count** instead.
97+
98+
Recommendation: Use **open_issues_count** instead.
8599

86100
1. Repository attribute: public
87-
: Recommendation: When [creating a repository](/v3/repos/#create), use the
101+
102+
Recommendation: When [creating a repository](/v3/repos/#create), use the
88103
**private** attribute to indicate whether the repository should be public or
89104
private. Do not use the **public** attribute.
90105

91106
1. Repository attribute: watchers
92-
: Recommendation: Use **watchers_count** instead.
107+
108+
Recommendation: Use **watchers_count** instead.
93109

94110
1. User attribute: bio
95-
: Recommendation: Do not use this attribute. It is obsolete.
111+
112+
Recommendation: Do not use this attribute. It is obsolete.
96113

97114
1. User attribute: plan["collaborators"]
98-
: Recommendation: Do not use this attribute. It is obsolete.
115+
116+
Recommendation: Do not use this attribute. It is obsolete.
99117

100118
1. User attribute: gravatar_id
101-
: Recommendation: Use **avatar_url** instead.
119+
120+
Recommendation: Use **avatar_url** instead.
102121

103122
1. Feed attribute: current_user_organization_url
104-
: Recommendation: Use **current_user_organization_urls** instead.
123+
124+
Recommendation: Use **current_user_organization_urls** instead.
105125

106126
1. Feed attribute: current_user_organization
107-
: Recommendation: Use **current_user_organizations** instead.
127+
128+
Recommendation: Use **current_user_organizations** instead.
108129

109130
1. Pagination parameters `top` and `sha` for method: /repos/:owner/:repo/commits
110-
: Recommendation: When fetching [the list of commits for a repository](/v3/repos/commits/#list-commits-on-a-repository)
131+
132+
Recommendation: When fetching [the list of commits for a repository](/v3/repos/commits/#list-commits-on-a-repository)
111133
use the [standard `per_page` and `page` parameters](/v3/#pagination) for pagination, instead of `per_page`,
112134
`top`, and `sha`.
113135

114136
1. Authorization attribute: token
115-
: Recommendation: This attribute will return an empty string in the majority of
137+
138+
Recommendation: This attribute will return an empty string in the majority of
116139
the Authorizations API responses. Please see
117140
[the deprecation blog post](/changes/2015-04-20-authorizations-api-response-changes-are-now-in-effect/)
118141
and the [Authorizations API deprecation notice](/v3/oauth_authorizations/#deprecation-notice)
119142
for full details.
120143

121144
1. Team attribute: permission
122-
: Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add team repository](/v3/orgs/teams/#add-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add team repository](/v3/orgs/teams/#add-team-repository) with a `permission` attribute to update each repository's permission separately.
145+
146+
Recommendation: This attribute no longer dictates the permission a team has on its repositories; it only dictates the default permission that the [Add team repository](/v3/orgs/teams/#add-team-repository) API will use for requests where no `permission` attribute is specified. To change the permission level for every repository on a team, use the [List team repositories](/v3/orgs/teams/#list-team-repos) API to list all of the team's repositories, and then use the [Add team repository](/v3/orgs/teams/#add-team-repository) with a `permission` attribute to update each repository's permission separately.
123147

124148
<a id="beta">
125149

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