Skip to content
This repository has been archived by the owner on Nov 1, 2017. It is now read-only.

Commit

Permalink
correct Accept media type to remove sha suffix
Browse files Browse the repository at this point in the history
  • Loading branch information
shiftkey committed Jun 7, 2016
1 parent fec818e commit 84bb8fa
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 66 deletions.
33 changes: 1 addition & 32 deletions content/v3/git/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Please see the [blog post](/changes/2016-04-04-git-signing-api-preview) for full

To receive signature verification data in commit objects you must provide a custom [media type](/v3/media) in the `Accept` header:

application/vnd.github.cryptographer-preview+sha
application/vnd.github.cryptographer-preview

{{/tip}}

Expand All @@ -83,35 +83,4 @@ To receive signature verification data in commit objects you must provide a cust
<%= headers 200 %>
<%= json(:signed_git_commit) %>

### The `verification` object

The response will include a `verification` field whose value is an object describing the result of verifying the commit's signature. The following fields are included in the `verification` object:

Name | Type | Description
-----|------|--------------
`verified`|`boolean` | Does GitHub consider the signature in this commit to be verified?
`reason`|`string` | The reason for `verified` value. Possible values and their meanings are enumerated in the table bellow.
`signature`|`string` | The signature that was extracted from the commit.
`payload`|`string` | The value that was signed.

#### The `reason` field

The following are possible `reason`s that may be included in the `verification` object:

Value | Description
------|------------
`expired_key` | The key that made the signature is expired.
`not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error` | There was an error communicating with the signature-verification service.
`gpgverify_unavailable` | The signature-verification service is currently unavailable.
`unsigned` | The object does not include a signature.
`unkown_signature_type` | A non-PGP signature was found in the commit.
`no_user` | No user was associated with the `committer` email address in the commit.
`unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account.
`bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key` | The key that made the signature has not been registered with any user's account.
`malformed_signature` | There was an error parsing the signature.
`invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid` | None of the above errors applied, so the signature is considered to be verified.

{% endif %}
2 changes: 1 addition & 1 deletion content/v3/git/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Please see the [blog post](/changes/2016-04-04-git-signing-api-preview) for full

To receive signature verification data in tag objects you must provide a custom [media type](/v3/media) in the `Accept` header:

application/vnd.github.cryptographer-preview+sha
application/vnd.github.cryptographer-preview

{{/tip}}

Expand Down
33 changes: 1 addition & 32 deletions content/v3/repos/commits.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Please see the [blog post](/changes/2016-04-04-git-signing-api-preview) for full

To receive signature verification data in commit objects you must provide a custom [media type](/v3/media) in the `Accept` header:

application/vnd.github.cryptographer-preview+sha
application/vnd.github.cryptographer-preview

{{/tip}}

Expand All @@ -109,35 +109,4 @@ To receive signature verification data in commit objects you must provide a cust
<%= headers 200 %>
<%= json(:signed_commit) %>

### The `verification` object

The response will include a `verification` field whose value is an object describing the result of verifying the commit's signature. The following fields are included in the `verification` object:

Name | Type | Description
-----|------|--------------
`verified`|`boolean` | Does GitHub consider the signature in this commit to be verified?
`reason`|`string` | The reason for `verified` value. Possible values and their meanings are enumerated in the table bellow.
`signature`|`string` | The signature that was extracted from the commit.
`payload`|`string` | The value that was signed.

#### The `reason` field

The following are possible `reason`s that may be included in the `verification` object:

Value | Description
------|------------
`expired_key` | The key that made the signature is expired.
`not_signing_key` | The "signing" flag is not among the usage flags in the GPG key that made the signature.
`gpgverify_error` | There was an error communicating with the signature-verification service.
`gpgverify_unavailable` | The signature-verification service is currently unavailable.
`unsigned` | The object does not include a signature.
`unkown_signature_type` | A non-PGP signature was found in the commit.
`no_user` | No user was associated with the `committer` email address in the commit.
`unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account.
`bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature.
`unknown_key` | The key that made the signature has not been registered with any user's account.
`malformed_signature` | There was an error parsing the signature.
`invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature.
`valid` | None of the above errors applied, so the signature is considered to be verified.

{% endif %}
2 changes: 1 addition & 1 deletion content/v3/users/gpg_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ title: User GPG Keys

To access the API you must provide a custom [media type](/v3/media) in the `Accept` header:

application/vnd.github.cryptographer-preview+sha
application/vnd.github.cryptographer-preview

{{/tip}}

Expand Down

0 comments on commit 84bb8fa

Please sign in to comment.