Skip to content

Commit 34a7456

Browse files
committed
Remove misleading parameters in notifications API
The API allows you to mark notifications as read. To do so, you can specify any one of the following parameters and values. - "unread" : false - "read" : true - none of the above In all cases, the result is the same: it marks the notifications as read. Therefore, passing neither is the simplest approach, and there is no reason to describe these parameters.
1 parent 0d102c8 commit 34a7456

1 file changed

Lines changed: 0 additions & 20 deletions

File tree

content/v3/activity/notifications.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,6 @@ on GitHub.com](https://github.com/notifications).
108108

109109
### Input
110110

111-
unread
112-
: **Boolean** Changes the unread status of the threads.
113-
114-
read
115-
: **Boolean** Inverse of "unread".
116-
117111
last_read_at
118112
: _Optional_ **Time** Describes the last point that notifications were checked. Anything
119113
updated since this time will not be updated. Default: Now. Expected in ISO
@@ -132,12 +126,6 @@ from the [default view on GitHub.com](https://github.com/notifications).
132126

133127
### Input
134128

135-
unread
136-
: **Boolean** Changes the unread status of the threads.
137-
138-
read
139-
: **Boolean** Inverse of "unread".
140-
141129
last_read_at
142130
: _Optional_ **Time** Describes the last point that notifications were checked. Anything
143131
updated since this time will not be updated. Default: Now. Expected in ISO
@@ -160,14 +148,6 @@ updated since this time will not be updated. Default: Now. Expected in ISO
160148

161149
PATCH /notifications/threads/:id
162150

163-
### Input
164-
165-
unread
166-
: **Boolean** Changes the unread status of the threads.
167-
168-
read
169-
: **Boolean** Inverse of "unread".
170-
171151
### Response
172152

173153
<%= headers 205 %>

0 commit comments

Comments
 (0)