Skip to content

Commit 651b950

Browse files
gjtorikiangjtorikian
committed
Standardize the timestamp message
1 parent a6eca1a commit 651b950

File tree

10 files changed

+18
-19
lines changed

10 files changed

+18
-19
lines changed

‎content/v3/activity/notifications.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Name | Type | Description | Default
6161
----|------|--------------|---------
6262
`all`|`boolean` | If `true`, show notifications marked as read.|`false`
6363
`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned.|`false`
64-
`since`|`time` | Filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Example: "2012-10-09T23:39:01Z".|
64+
`since`|`string` | Filters out any notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
6565

6666

6767
### Response
@@ -81,7 +81,7 @@ Name | Type | Description | Default
8181
----|------|--------------|---------
8282
`all`|`boolean` | If `true`, show notifications marked as read.|`false`
8383
`participating`|`boolean` | If `true`, only shows notifications in which the user is directly participating or mentioned.|`false`
84-
`since`|`time` | Filters out any notifications updated before the given time. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Example: "2012-10-09T23:39:01Z".|
84+
`since`|`string` | Filters out any notifications updated before the given time. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
8585

8686

8787
### Response
@@ -100,7 +100,7 @@ on GitHub.com](https://github.com/notifications).
100100

101101
Name | Type | Description | Default
102102
----|------|--------------|---------
103-
`last_read_at`|`time` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. Expected in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Example: "2012-10-09T23:39:01Z".|Now.
103+
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.| Now.
104104

105105

106106
### Response
@@ -118,7 +118,7 @@ from the [default view on GitHub.com](https://github.com/notifications).
118118

119119
Name | Type | Description | Default
120120
----|------|--------------|---------
121-
`last_read_at`|`time` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. Expected in ISO 8601 format: `YYYY|MM-DDTHH:MM:SSZ`. Example: "2012-10-09T23:39:01Z".|Now.
121+
`last_read_at`|`string` | Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|Now.
122122

123123

124124
### Response

‎content/v3/activity/watching.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ List repositories being watched by the authenticated user.
6464

6565
Name | Type | Description | Default
6666
----|------|--------------|---------
67-
`subscribed`|`boolean`| Determines if notifications should be received from this repository.||
68-
`ignored`|`boolean`| Determines if all notifications should be blocked from this repository.||
67+
`subscribed`|`boolean`| Determines if notifications should be received from this repository.|
68+
`ignored`|`boolean`| Determines if all notifications should be blocked from this repository.|
6969

7070

7171
### Response

‎content/v3/gists.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Name | Type | Description | Default
4040
----|------|--------------|---------
4141
`since`|`string` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.|
4242

43-
4443
### Response
4544

4645
<%= headers 200, :pagination => true %>

‎content/v3/git/commits.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Name | Type | Description | Default
4545
-----|------|-------------|---------
4646
`name`|`string` | The name of the author (or commiter) of the commit|
4747
`email`|`string` | The email of the author (or commiter) of the commit|
48-
`date`|`string` | Indicates when this commit was authored (or committed). The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
48+
`date`|`string` | Indicates when this commit was authored (or committed). This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
4949

5050
### Example Input
5151

‎content/v3/git/tags.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ The `tagger` hash contains the following keys:
4545

4646
Name | Type | Description | Default
4747
----|------|--------------|---------
48-
`name`|| The name of the author of the tag|
49-
`email`|| The email of the author of the tag|
50-
`date`|| When this object was tagged. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
48+
`name`|`string`| The name of the author of the tag|
49+
`email`|`string`| The email of the author of the tag|
50+
`date`|`string`| When this object was tagged. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
5151

5252

5353
### Example Input

‎content/v3/issues.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Name | Type | Description | Default
3535
`labels`|`string`| A list of comma separated label names. Example: `bug,ui,@high`|
3636
`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `comments`.|`created`
3737
`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`.|`desc`
38-
`since`|`string` | Only issues updated at or after this time are returned. A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
38+
`since`|`string` | Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
3939

4040
### Response
4141

@@ -58,7 +58,7 @@ Name | Type | Description | Default
5858
`labels`|`string`| A list of comma separated label names. Example: `bug,ui,@high`|
5959
`sort`|`string`| What to sort results by. Can be either `created`, `updated`, `comments`.|`created`
6060
`direction`|`string`| The direction of the sort. Can be either `asc` or `desc`.|`desc`
61-
`since`|`string` | Only issues updated at or after this time are returned. A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
61+
`since`|`string` |Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
6262

6363
### Response
6464

‎content/v3/issues/comments.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Name | Type | Description | Default
3535
----|------|--------------|---------
3636
`sort`|`string` | Either `created` or `updated`.|`created`
3737
`direction`|`string` | Either `asc` or `desc`. Ignored without `sort` parameter.|
38-
`since`|`string` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
38+
`since`|`string` | Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
3939

4040

4141
### Response

‎content/v3/issues/milestones.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Name | Type | Description | Default
4545
`title`|`string` | **Required**. The title of the milestone.|
4646
`state`|`string` | The state of the milestone. Either `open` or `closed`.|`open`
4747
`description`|`string` | A description of the milestone.|
48-
`due_on`|`time` | The milestone due date. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`|
48+
`due_on`|`string` | The milestone due date. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
4949

5050
#### Example
5151

@@ -74,7 +74,7 @@ Name | Type | Description | Default
7474
`title`|`string` | The title of the milestone.|
7575
`state`|`string` | The state of the milestone. Either `open` or `closed`.|`open`
7676
`description`|`string` | A description of the milestone.|
77-
`due_on`|`time` | The milestone due date. The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`|
77+
`due_on`|`string` | The milestone due date. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
7878

7979
#### Example
8080

‎content/v3/pulls/comments.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Name | Type | Description | Default
3737
-----|------|-------------|---------
3838
`sort`|`string` | Can be either `created` or `updated`|`created`
3939
`direction`|`string` | Can be either `asc` or `desc`. Ignored without `sort` parameter.|
40-
`since`|`string` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only comments updated at or after this time are returned.|
40+
`since`|`string` | Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
4141

4242

4343
### Response

‎content/v3/repos/commits.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Name | Type | Description | Default
2525
`sha`|`string` | SHA or branch to start listing commits from.|
2626
`path`|`string` | Only commits containing this file path will be returned.|
2727
`author`|`string` | GitHub login, name, or email by which to filter by commit author|
28-
`since`|`time` | The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only commits after this date will be returned|
29-
`until`|`time` | The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only commits before this date will be returned|
28+
`since`|`string` | Only commits after this date will be returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
29+
`until`|`string` | Only commits before this date will be returned. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.|
3030

3131

3232
### Response

0 commit comments

Comments
 (0)