Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings
This repository was archived by the owner on Nov 1, 2017. It is now read-only.

Commite1c1406

Browse files
committed
Reswizzle, stub Notifications docs
1 parent7dd92da commite1c1406

File tree

7 files changed

+148
-9
lines changed

7 files changed

+148
-9
lines changed

‎content/v3/activity.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title:Activity | GitHub API
3+
---
4+
5+
#Activity
6+
7+
Placeholder for intro to Notifications, Starring, Watching, Events,
8+
Following(?) and other stuffs
9+
File renamed without changes.
File renamed without changes.
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
title:Notifications | GitHub API
3+
---
4+
5+
#Notifications API
6+
7+
* TOC
8+
{:toc}
9+
10+
GitHub Notifications are powered by[watched repositories](/v3/repos/watching/).
11+
Users receive notifications for discussions in repositories they watch
12+
including:
13+
14+
* Issues and their comments
15+
* Pull Requests and their comments
16+
* Comments on any commits
17+
18+
Notifications are also sent for discussions in unwatched repositories when the
19+
user is involved including:
20+
21+
***@mentions**
22+
* Assignments
23+
* Commits the user authors or commits
24+
* Any discussion in which the user actively participates
25+
26+
27+
##List your notifications
28+
29+
List all notifications for the current user, grouped by repository.
30+
31+
GET /notifications
32+
33+
###Parameters
34+
35+
all
36+
:_Optional_**boolean**`true` to show notifications marked as read.
37+
38+
participating
39+
:_Optional_**boolean**`true` to show only notifications in which the user is
40+
directly participating or mentioned.
41+
42+
43+
##List your notifications in a repository
44+
45+
List all notifications for the current user.
46+
47+
GET /repos/:owner/:repo/notifications
48+
49+
###Parameters
50+
51+
all
52+
:_Optional_**boolean**`true` to show notifications marked as read.
53+
54+
participating
55+
:_Optional_**boolean**`true` to show only notifications in which the user is
56+
directly participating or mentioned.
57+
58+
##Mark as read
59+
60+
Marking a notification as "read" archives it removes it from the[default view
61+
on GitHub.com](https://github.com/notifications).
62+
63+
POST /notifications/mark_as_read
64+
65+
###Parameters
66+
67+
ids
68+
:_Optional_**Array(Number)** IDs of notifications to mark as read. If this
69+
parameter is omitted, all notifications will be marked as read.
70+
71+
##Mark notifications as read in a repository
72+
73+
Marking all notification in a repository as "read" archives them removes them
74+
from the[default view on GitHub.com](https://github.com/notifications).
75+
76+
POST /repos/:owner/:repo/notifications/mark_as_read
77+
78+
##Mute a thread
79+
80+
Muting a thread prevents future notifications from being sent for a discussion
81+
thread.
82+
83+
POST /notifications/threads/:id/mute
84+
85+
##Unmute a thread
86+
87+
Muting a thread enables future notifications from being sent for a discussion
88+
thread.
89+
90+
POST /notifications/threads/:id/unmute
91+
92+
##Settings
93+
94+
Update the notification settings for the authenticated user.
95+
96+
PATCH /notifications/settings
97+
98+
###Parameters
99+
100+
participating.email
101+
:_Optional_**boolean**`true` to receive participating notificationsn via
102+
email.
103+
104+
participating.web
105+
:_Optional_**boolean**`true` to receive participating notificationsn via
106+
web.
107+
108+
watching.email
109+
:_Optional_**boolean**`true` to receive watching notificationsn via
110+
email.
111+
112+
watching.web
113+
:_Optional_**boolean**`true` to receive watching notificationsn via
114+
web.
115+
116+
117+
##Organization email address settings
118+
119+
Update the notification settings for the authenticated user.
120+
121+
PATCH /orgs/:org/notifications/settings
122+
123+
###Parameters
124+
125+
email
126+
:_Required_**string** Email address to which to send notifications to the
127+
authenticated user for discussions related to projects for this organization.
128+
File renamed without changes.
File renamed without changes.

‎layouts/default.html‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,23 @@
4242
<divclass="js-toggle-list sidebar-module expandable">
4343
<ul>
4444
<liclass="js-topic">
45-
<h3><ahref="#"class="js-expand-btn collapsed">&nbsp;</a><ahref="/v3/">Summary</a></h3>
45+
<h3><ahref="#"class="js-expand-btn collapsed">&nbsp;</a><ahref="/v3/">Overview</a></h3>
4646
<ulclass="js-guides">
4747
<li><ahref="/v3/oauth/">OAuth</a></li>
4848
<li><ahref="/v3/media/">Media Types</a></li>
4949
<li><ahref="/v3/libraries/">Libraries</a></li>
5050
</ul>
5151
</li>
52+
<liclass="js-topic">
53+
<h3><ahref="#"class="js-expand-btn collapsed">&nbsp;</a><ahref="/v3/activity/">Activity</a></h3>
54+
<ulclass="js-guides">
55+
<li><ahref="/v3/activity/events/">Events</a></li>
56+
<li><ahref="/v3/activity/events/types/">Event Types</a></li>
57+
<li><ahref="/v3/activity/notifications/">Notifications</a></li>
58+
<li><ahref="/v3/activity/starring/">Starring</a></li>
59+
<li><ahref="/v3/activity/watching/">Watching</a></li>
60+
</ul>
61+
</li>
5262
<liclass="js-topic">
5363
<h3><ahref="#"class="js-expand-btn collapsed">&nbsp;</a><ahref="/v3/gists/">Gists</a></h3>
5464
<ulclass="js-guides">
@@ -100,9 +110,7 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/repos/">R
100110
<li><ahref="/v3/repos/keys/">Keys</a></li>
101111
<li><ahref="/v3/repos/hooks/">Hooks</a></li>
102112
<li><ahref="/v3/repos/merging/">Merging</a></li>
103-
<li><ahref="/v3/repos/starring/">Starring</a></li>
104113
<li><ahref="/v3/repos/statuses/">Statuses</a></li>
105-
<li><ahref="/v3/repos/watching/">Watching</a></li>
106114
</ul>
107115
</li>
108116
<liclass="js-topic">
@@ -113,12 +121,6 @@ <h3><a href="#" class="js-expand-btn collapsed">&nbsp;</a><a href="/v3/users/">U
113121
<li><ahref="/v3/users/keys/">Keys</a></li>
114122
</ul>
115123
</li>
116-
<liclass="js-topic">
117-
<h3><ahref="#"class="js-expand-btn collapsed">&nbsp;</a><ahref="/v3/events/">Events</a></h3>
118-
<ulclass="js-guides">
119-
<li><ahref="/v3/events/types/">Types</a></li>
120-
</ul>
121-
</li>
122124
<liclass="js-topic">
123125
<h3><ahref="#"class="js-expand-btn collapsed">&nbsp;</a><ahref="/v3/search/">Search</a></h3>
124126
<ulclass="js-guides">

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp