Skip to content

Commit ccdbf74

Browse files
author
Hubot
committed
Sync changes from upstream repository
1 parent 331ad80 commit ccdbf74

10 files changed

Lines changed: 22 additions & 22 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Key | Type | Description
112112
----|------|-------------
113113
`state` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
114114
`target_url` |`string` | The optional link added to the status.
115-
`deployment` |`hash` | The deployment that this status is associated with.
115+
`deployment` |`object` | The deployment that this status is associated with.
116116
`description`|`string` | The optional human-readable description added to the status.
117117

118118
<%= webhook_payload "deployment_status" %>

‎content/v3/gists.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ The keys in the `files` object are the `string` filename. The value is another `
119119

120120
<div class="alert">
121121
<p>
122-
<strong>Note</strong>: All files from the previous version of the gist are carried over by default if not included in the hash. Deletes can be performed by including the filename with a <code>null</code> hash.
122+
<strong>Note</strong>: All files from the previous version of the gist are carried over by default if not included in the object. Deletes can be performed by including the filename with a <code>null</code> object.
123123
</p>
124124
</div>
125125

‎content/v3/git/commits.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ Name | Type | Description
3131

3232
### Optional Parameters
3333

34-
You can provide an additional `committer` parameter, which is a hash containing
34+
You can provide an additional `committer` parameter, which is an object containing
3535
information about the committer. Or, you can provide an `author` parameter, which
36-
is a hash containing information about the author.
36+
is an object containing information about the author.
3737

3838
The `committer` section is optional and will be filled with the `author`
3939
data if omitted. If the `author` section is omitted, it will be filled

‎content/v3/git/tags.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Name | Type | Description
3939
`message`|`string`| The tag message
4040
`object`|`string`| The SHA of the git object this is tagging
4141
`type`|`string`| The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.
42-
`tagger`|`hash`| A hash with information about the individual creating the tag.
42+
`tagger`|`object`| An object with information about the individual creating the tag.
4343

44-
The `tagger` hash contains the following keys:
44+
The `tagger` object contains the following keys:
4545

4646
Name | Type | Description
4747
-----|------|--------------

‎content/v3/git/trees.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ a new tree out.
5151

5252
Name | Type | Description
5353
-----|------|--------------
54-
`tree`|`array` of `hash`es | **Required**. Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure
54+
`tree`|`array` of `object`s | **Required**. Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure
5555
`base_tree`| `string` | The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.
5656

5757
The `tree` parameter takes the following keys:

‎content/v3/orgs/hooks.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,12 @@ In order to protect sensitive data which may be present in webhook configuration
6262
Name | Type | Description
6363
-----|------|--------------
6464
`name`|`string` | **Required**. Must be passed as "web".
65-
`config`|`hash` | **Required**. Key/value pairs to provide settings for this webhook. [These are defined below](#create-hook-config-params).
65+
`config`|`object` | **Required**. Key/value pairs to provide settings for this webhook. [These are defined below](#create-hook-config-params).
6666
`events`|`array` | Determines what [events][event-types] the hook is triggered for. Default: `["push"]`.
6767
`active`|`boolean` | Determines whether the hook is actually triggered on pushes.
6868

6969
<a name="create-hook-config-params"></a>
70-
The `config` hash can accept the following keys:
70+
The `config` object can accept the following keys:
7171

7272
<%= fetch_content(:org_hook_config_hash) %>
7373

@@ -99,12 +99,12 @@ Here's how you can create a hook that posts payloads in JSON format:
9999

100100
Name | Type | Description
101101
-----|------|--------------
102-
`config`|`hash` | **Required**. Key/value pairs to provide settings for this webhook. [These are defined below](#update-hook-config-params).
102+
`config`|`object` | **Required**. Key/value pairs to provide settings for this webhook. [These are defined below](#update-hook-config-params).
103103
`events`|`array` | Determines what [events][event-types] the hook is triggered for. Default: `["push"]`.
104104
`active`|`boolean` | Determines whether the hook is actually triggered on pushes.
105105

106106
<a name="update-hook-config-params"></a>
107-
The `config` hash can accept the following keys:
107+
The `config` object can accept the following keys:
108108

109109
<%= fetch_content(:org_hook_config_hash) %>
110110

‎content/v3/repos/contents.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ In the next major version of the API, the type will be returned as "submodule".
6969

7070
If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](#response-if-content-is-a-file)).
7171

72-
Otherwise, the API responds with a hash describing the symlink itself:
72+
Otherwise, the API responds with an object describing the symlink itself:
7373

7474
<%= headers 200 %>
7575
<%= json :symlink_content %>
@@ -101,9 +101,9 @@ Name | Type | Description
101101

102102
### Optional Parameters
103103

104-
You can provide an additional `committer` parameter, which is a hash containing
104+
You can provide an additional `committer` parameter, which is an object containing
105105
information about the committer. Or, you can provide an `author` parameter, which
106-
is a hash containing information about the author.
106+
is an object containing information about the author.
107107

108108
The `author` section is optional and is filled in with the `committer`
109109
information if omitted. If the `committer` information is omitted, the authenticated
@@ -149,9 +149,9 @@ Name | Type | Description
149149

150150
### Optional Parameters
151151

152-
You can provide an additional `committer` parameter, which is a hash containing
152+
You can provide an additional `committer` parameter, which is an object containing
153153
information about the committer. Or, you can provide an `author` parameter, which
154-
is a hash containing information about the author.
154+
is an object containing information about the author.
155155

156156
The `author` section is optional and is filled in with the `committer`
157157
information if omitted. If the `committer` information is omitted, the authenticated
@@ -198,9 +198,9 @@ Name | Type | Description
198198

199199
### Optional Parameters
200200

201-
You can provide an additional `committer` parameter, which is a hash containing
201+
You can provide an additional `committer` parameter, which is an object containing
202202
information about the committer. Or, you can provide an `author` parameter, which
203-
is a hash containing information about the author.
203+
is an object containing information about the author.
204204

205205
The `author` section is optional and is filled in with the `committer`
206206
information if omitted. If the `committer` information is omitted, the authenticated

‎content/v3/repos/hooks.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Repositories can have multiple webhooks installed. Each webhook should have a un
4444
Name | Type | Description
4545
-----|------|--------------
4646
`name`|`string` | **Required**. The name of the service that is being called. (See <a href='https://api.github.com/hooks' data-proofer-ignore>/hooks</a> for the list of valid hook names.)
47-
`config`|`hash` | **Required**. Key/value pairs to provide settings for this hook. These settings vary between the services and are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON `true`/`false` values will be converted automatically.
47+
`config`|`object` | **Required**. Key/value pairs to provide settings for this hook. These settings vary between the services and are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON `true`/`false` values will be converted automatically.
4848
`events`|`array` | Determines what events the hook is triggered for. Default: `["push"]`
4949
`active`|`boolean` | Determines whether the hook is actually triggered on pushes.
5050

@@ -82,7 +82,7 @@ Here's how you can create a hook that posts payloads in JSON format:
8282

8383
Name | Type | Description
8484
-----|------|--------------
85-
`config`|`hash` | Key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between the services and are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON `true`/`false` values will be converted automatically.
85+
`config`|`object` | Key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary between the services and are defined in the [github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON `true`/`false` values will be converted automatically.
8686
`events`|`array` | Determines what events the hook is triggered for. This replaces the entire array of events. Default: `["push"]`
8787
`add_events`|`array` | Determines a list of events to be added to the list of events that the Hook triggers for.
8888
`remove_events`|`array` | Determines a list of events to be removed from the list of events that the Hook triggers for.

‎content/v3/search.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ in your Accept header.
387387
application/vnd.github.v3.text-match+json
388388

389389
The results will provide the same JSON payloads as shown above, with an extra
390-
key called `text_matches`. Inside the `text_matches` array, each hash includes
390+
key called `text_matches`. Inside the `text_matches` array, each object includes
391391
the following attributes:
392392

393393

‎content/v3/versions.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For [Repositories](/v3/repos/#get), the v3 media type omits the `master_branch`
3131

3232
### User Emails JSON
3333

34-
For [User Emails](/v3/users/emails/#list-email-addresses-for-a-user), the v3 media type returns an array of hashes (instead of an array of strings).
34+
For [User Emails](/v3/users/emails/#list-email-addresses-for-a-user), the v3 media type returns an array of objects (instead of an array of strings).
3535

3636
## v3 deprecations
3737

0 commit comments

Comments
 (0)