Skip to content

Commit e2d8787

Browse files
author
Marc-Andre Giroux
authored
Merge pull request #51 from github/def-import-1602254112
Update OpenAPI Descriptions
2 parents d98d45a + 786cf28 commit e2d8787

24 files changed

+600
-108
lines changed

‎descriptions/api.github.com./api.github.com..json

+8-8
Large diffs are not rendered by default.

‎descriptions/api.github.com./api.github.com..yaml

+42-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
openapi: 3.0.3
33
info:
4-
version: 1.0.0
4+
version: 1.0.1
55
title: GitHub v3 REST API
66
description: GitHub's v3 REST API.
77
license:
@@ -16088,14 +16088,18 @@ paths:
1608816088
summary: List commits
1608916089
description: |-
1609016090
**Signature verification object**
16091+
1609116092
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
16093+
1609216094
| Name | Type | Description |
1609316095
| ---- | ---- | ----------- |
1609416096
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1609516097
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1609616098
| `signature` | `string` | The signature that was extracted from the commit. |
1609716099
| `payload` | `string` | The value that was signed. |
16100+
1609816101
These are the possible values for `reason` in the `verification` object:
16102+
1609916103
| Value | Description |
1610016104
| ----- | ----------- |
1610116105
| `expired_key` | The key that made the signature is expired. |
@@ -16397,18 +16401,26 @@ paths:
1639716401
summary: Get a commit
1639816402
description: |-
1639916403
Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.
16404+
1640016405
**Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing.
16406+
1640116407
You can pass the appropriate [media type](https://developer.github.com./v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.
16408+
1640216409
To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com./v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.
16410+
1640316411
**Signature verification object**
16412+
1640416413
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
16414+
1640516415
| Name | Type | Description |
1640616416
| ---- | ---- | ----------- |
1640716417
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1640816418
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1640916419
| `signature` | `string` | The signature that was extracted from the commit. |
1641016420
| `payload` | `string` | The value that was signed. |
16421+
1641116422
These are the possible values for `reason` in the `verification` object:
16423+
1641216424
| Value | Description |
1641316425
| ----- | ----------- |
1641416426
| `expired_key` | The key that made the signature is expired. |
@@ -16758,21 +16770,31 @@ paths:
1675816770
summary: Compare two commits
1675916771
description: |-
1676016772
Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `<USERNAME>:branch`.
16773+
1676116774
The response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com./v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.
16775+
1676216776
The response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.
16777+
1676316778
**Working with large comparisons**
16779+
1676416780
The response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://developer.github.com./v3/repos/commits/#list-commits) to enumerate all commits in the range.
16781+
1676516782
For comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long
1676616783
to generate. You can typically resolve this error by using a smaller commit range.
16784+
1676716785
**Signature verification object**
16786+
1676816787
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
16788+
1676916789
| Name | Type | Description |
1677016790
| ---- | ---- | ----------- |
1677116791
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1677216792
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1677316793
| `signature` | `string` | The signature that was extracted from the commit. |
1677416794
| `payload` | `string` | The value that was signed. |
16795+
1677516796
These are the possible values for `reason` in the `verification` object:
16797+
1677616798
| Value | Description |
1677716799
| ----- | ----------- |
1677816800
| `expired_key` | The key that made the signature is expired. |
@@ -18083,15 +18105,20 @@ paths:
1808318105
summary: Create a commit
1808418106
description: |-
1808518107
Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
18108+
1808618109
**Signature verification object**
18110+
1808718111
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
18112+
1808818113
| Name | Type | Description |
1808918114
| ---- | ---- | ----------- |
1809018115
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1809118116
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1809218117
| `signature` | `string` | The signature that was extracted from the commit. |
1809318118
| `payload` | `string` | The value that was signed. |
18119+
1809418120
These are the possible values for `reason` in the `verification` object:
18121+
1809518122
| Value | Description |
1809618123
| ----- | ----------- |
1809718124
| `expired_key` | The key that made the signature is expired. |
@@ -18240,15 +18267,20 @@ paths:
1824018267
summary: Get a commit
1824118268
description: |-
1824218269
Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).
18270+
1824318271
**Signature verification object**
18272+
1824418273
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
18274+
1824518275
| Name | Type | Description |
1824618276
| ---- | ---- | ----------- |
1824718277
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1824818278
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1824918279
| `signature` | `string` | The signature that was extracted from the commit. |
1825018280
| `payload` | `string` | The value that was signed. |
18281+
1825118282
These are the possible values for `reason` in the `verification` object:
18283+
1825218284
| Value | Description |
1825318285
| ----- | ----------- |
1825418286
| `expired_key` | The key that made the signature is expired. |
@@ -18533,15 +18565,20 @@ paths:
1853318565
summary: Create a tag object
1853418566
description: |-
1853518567
Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com./v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com./v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.
18568+
1853618569
**Signature verification object**
18570+
1853718571
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
18572+
1853818573
| Name | Type | Description |
1853918574
| ---- | ---- | ----------- |
1854018575
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1854118576
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1854218577
| `signature` | `string` | The signature that was extracted from the commit. |
1854318578
| `payload` | `string` | The value that was signed. |
18579+
1854418580
These are the possible values for `reason` in the `verification` object:
18581+
1854518582
| Value | Description |
1854618583
| ----- | ----------- |
1854718584
| `expired_key` | The key that made the signature is expired. |
@@ -18648,14 +18685,18 @@ paths:
1864818685
summary: Get a tag
1864918686
description: |-
1865018687
**Signature verification object**
18688+
1865118689
The response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:
18690+
1865218691
| Name | Type | Description |
1865318692
| ---- | ---- | ----------- |
1865418693
| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |
1865518694
| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |
1865618695
| `signature` | `string` | The signature that was extracted from the commit. |
1865718696
| `payload` | `string` | The value that was signed. |
18697+
1865818698
These are the possible values for `reason` in the `verification` object:
18699+
1865918700
| Value | Description |
1866018701
| ----- | ----------- |
1866118702
| `expired_key` | The key that made the signature is expired. |

0 commit comments

Comments
 (0)