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

github/developer.github.comPublic archive

NotificationsYou must be signed in to change notification settings
Fork1.1k
Star1.3k

Commit6035ca7

committed

Merge pull request#441 from github/object-not-hash

Use term object instead of hash when talking about JSON

2 parents6cf0e1c +56a8499 commit6035ca7Copy full SHA for 6035ca7

File tree

10 files changed

+22

-22

lines changed

content/v3
- activity/events
  - types.md
- gists.md
- git
- orgs
  - hooks.md
- repos
  - contents.md
  - hooks.md
- search.md
- versions.md

10 files changed

+22

-22

lines changed

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

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ Key \| Type \| Description`
`112`	`112`	`----\|------\|-------------`
`113`	`113`	`state` \|`string` \| The new state. Can be`pending`,`success`,`failure`, or`error`.
`114`	`114`	`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.
`116`	`116`	`description`\|`string` \| The optional human-readable description added to the status.
`117`	`117`
`118`	`118`	`<%= webhook_payload "deployment_status" %>`

`‎content/v3/gists.md‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -119,7 +119,7 @@ The keys in the `files` object are the `string` filename. The value is another `
`119`	`119`
`120`	`120`	`<divclass="alert">`
`121`	`121`	`<p>`
`122`		`-<strong>Note</strong>: All files from the previous version of the gist are carried over by default if not included in thehash. 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 theobject. Deletes can be performed by including the filename with a <code>null</code>object.`
`123`	`123`	`</p>`
`124`	`124`	`</div>`
`125`	`125`

`‎content/v3/git/commits.md‎`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,9 @@ Name \| Type \| Description`
`31`	`31`
`32`	`32`	`###Optional Parameters`
`33`	`33`
`34`		-You can provide an additional`committer` parameter, which isa hash containing
	`34`	+You can provide an additional`committer` parameter, which isan object containing
`35`	`35`	information about the committer. Or, you can provide an`author` parameter, which
`36`		`-isa hash containing information about the author.`
	`36`	`+isan object containing information about the author.`
`37`	`37`
`38`	`38`	The`committer` section is optional and will be filled with the`author`
`39`	`39`	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 number	Diff line number	Diff line change
`@@ -39,9 +39,9 @@ Name \| Type \| Description`
`39`	`39`	`message`\|`string`\| The tag message
`40`	`40`	`object`\|`string`\| The SHA of the git object this is tagging
`41`	`41`	`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.
`43`	`43`
`44`		-The`tagger`hash contains the following keys:
	`44`	+The`tagger`object contains the following keys:
`45`	`45`
`46`	`46`	`Name \| Type \| Description`
`47`	`47`	`-----\|------\|--------------`

`‎content/v3/git/trees.md‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ a new tree out.`
`51`	`51`
`52`	`52`	`Name \| Type \| Description`
`53`	`53`	`-----\|------\|--------------`
`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
`55`	`55`	`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.
`56`	`56`
`57`	`57`	The`tree` parameter takes the following keys:

`‎content/v3/orgs/hooks.md‎`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -62,12 +62,12 @@ In order to protect sensitive data which may be present in webhook configuration`
`62`	`62`	`Name \| Type \| Description`
`63`	`63`	`-----\|------\|--------------`
`64`	`64`	`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).
`66`	`66`	`events`\|`array` \| Determines what[events][event-types] the hook is triggered for. Default:`["push"]`.
`67`	`67`	`active`\|`boolean` \| Determines whether the hook is actually triggered on pushes.
`68`	`68`
`69`	`69`	`<aname="create-hook-config-params"></a>`
`70`		-The`config`hash can accept the following keys:
	`70`	+The`config`object can accept the following keys:
`71`	`71`
`72`	`72`	`<%= fetch_content(:org_hook_config_hash) %>`
`73`	`73`
`@@ -99,12 +99,12 @@ Here's how you can create a hook that posts payloads in JSON format:`
`99`	`99`
`100`	`100`	`Name \| Type \| Description`
`101`	`101`	`-----\|------\|--------------`
`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).
`103`	`103`	`events`\|`array` \| Determines what[events][event-types] the hook is triggered for. Default:`["push"]`.
`104`	`104`	`active`\|`boolean` \| Determines whether the hook is actually triggered on pushes.
`105`	`105`
`106`	`106`	`<aname="update-hook-config-params"></a>`
`107`		-The`config`hash can accept the following keys:
	`107`	+The`config`object can accept the following keys:
`108`	`108`
`109`	`109`	`<%= fetch_content(:org_hook_config_hash) %>`
`110`	`110`

`‎content/v3/repos/contents.md‎`

Lines changed: 7 additions & 7 deletions

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ In the next major version of the API, the type will be returned as "submodule".`
`69`	`69`
`70`	`70`	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)).
`71`	`71`
`72`		`-Otherwise, the API responds witha hash describing the symlink itself:`
	`72`	`+Otherwise, the API responds withan object describing the symlink itself:`
`73`	`73`
`74`	`74`	`<%= headers 200 %>`
`75`	`75`	`<%= json:symlink_content %>`
`@@ -101,9 +101,9 @@ Name \| Type \| Description`
`101`	`101`
`102`	`102`	`###Optional Parameters`
`103`	`103`
`104`		-You can provide an additional`committer` parameter, which isa hash containing
	`104`	+You can provide an additional`committer` parameter, which isan object containing
`105`	`105`	information about the committer. Or, you can provide an`author` parameter, which
`106`		`-isa hash containing information about the author.`
	`106`	`+isan object containing information about the author.`
`107`	`107`
`108`	`108`	The`author` section is optional and is filled in with the`committer`
`109`	`109`	information if omitted. If the`committer` information is omitted, the authenticated
`@@ -149,9 +149,9 @@ Name \| Type \| Description`
`149`	`149`
`150`	`150`	`###Optional Parameters`
`151`	`151`
`152`		-You can provide an additional`committer` parameter, which isa hash containing
	`152`	+You can provide an additional`committer` parameter, which isan object containing
`153`	`153`	information about the committer. Or, you can provide an`author` parameter, which
`154`		`-isa hash containing information about the author.`
	`154`	`+isan object containing information about the author.`
`155`	`155`
`156`	`156`	The`author` section is optional and is filled in with the`committer`
`157`	`157`	information if omitted. If the`committer` information is omitted, the authenticated
`@@ -198,9 +198,9 @@ Name \| Type \| Description`
`198`	`198`
`199`	`199`	`###Optional Parameters`
`200`	`200`
`201`		-You can provide an additional`committer` parameter, which isa hash containing
	`201`	+You can provide an additional`committer` parameter, which isan object containing
`202`	`202`	information about the committer. Or, you can provide an`author` parameter, which
`203`		`-isa hash containing information about the author.`
	`203`	`+isan object containing information about the author.`
`204`	`204`
`205`	`205`	The`author` section is optional and is filled in with the`committer`
`206`	`206`	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 number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ Repositories can have multiple webhooks installed. Each webhook should have a un`
`44`	`44`	`Name \| Type \| Description`
`45`	`45`	`-----\|------\|--------------`
`46`	`46`	`name`\|`string` \|Required. The name of the service that is being called. (See <ahref='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.
`48`	`48`	`events`\|`array` \| Determines what events the hook is triggered for. Default:`["push"]`
`49`	`49`	`active`\|`boolean` \| Determines whether the hook is actually triggered on pushes.
`50`	`50`
`@@ -82,7 +82,7 @@ Here's how you can create a hook that posts payloads in JSON format:`
`82`	`82`
`83`	`83`	`Name \| Type \| Description`
`84`	`84`	`-----\|------\|--------------`
`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.
`86`	`86`	`events`\|`array` \| Determines what events the hook is triggered for. This replaces the entire array of events. Default:`["push"]`
`87`	`87`	`add_events`\|`array` \| Determines a list of events to be added to the list of events that the Hook triggers for.
`88`	`88`	`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 number	Diff line number	Diff line change
`@@ -387,7 +387,7 @@ in your Accept header.`
`387`	`387`	`application/vnd.github.v3.text-match+json`
`388`	`388`
`389`	`389`	`The results will provide the same JSON payloads as shown above, with an extra`
`390`		-key called`text_matches`. Inside the`text_matches` array, eachhash includes
	`390`	+key called`text_matches`. Inside the`text_matches` array, eachobject includes
`391`	`391`	`the following attributes:`
`392`	`392`
`393`	`393`

`‎content/v3/versions.md‎`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -31,7 +31,7 @@ For [Repositories](/v3/repos/#get), the v3 media type omits the `master_branch`
`31`	`31`
`32`	`32`	`###User Emails JSON`
`33`	`33`
`34`		`-For[User Emails](/v3/users/emails/#list-email-addresses-for-a-user), the v3 media type returns an array ofhashes (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 ofobjects (instead of an array of strings).`
`35`	`35`
`36`	`36`	`##v3 deprecations`
`37`	`37`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit6035ca7

File tree

10 files changed

10 files changed

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

`‎content/v3/gists.md‎`

`‎content/v3/git/commits.md‎`

`‎content/v3/git/tags.md‎`

`‎content/v3/git/trees.md‎`

`‎content/v3/orgs/hooks.md‎`

`‎content/v3/repos/contents.md‎`

`‎content/v3/repos/hooks.md‎`

`‎content/v3/search.md‎`

`‎content/v3/versions.md‎`

0 commit comments