GitHub: Git schemas
7 GitHub schemas with complete fields and constraints.
← Git operations · All schemas
Create a blob — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Short Blob |
sha | string | Required within parent | |
url | string | Required within parent |
Create a commit — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Low-level Git commit operations within a repository |
author | object | Required within parent | Identifying information for the git-user |
author.date | string | Required within parent | Timestamp of the commit Format: date-time |
author.email | string | Required within parent | Git email address of the user |
author.name | string | Required within parent | Name of the git user |
committer | object | Required within parent | Identifying information for the git-user |
committer.date | string | Required within parent | Timestamp of the commit Format: date-time |
committer.email | string | Required within parent | Git email address of the user |
committer.name | string | Required within parent | Name of the git user |
html_url | string | Required within parent | Format: uri |
message | string | Required within parent | Message describing the purpose of the commit |
node_id | string | Required within parent | |
parents | array | Required within parent | |
parents[] | object | Each item | |
parents[].html_url | string | Required within parent | Format: uri |
parents[].sha | string | Required within parent | SHA for the commit |
parents[].url | string | Required within parent | Format: uri |
sha | string | Required within parent | SHA for the commit |
tree | object | Required within parent | |
tree.sha | string | Required within parent | SHA for the commit |
tree.url | string | Required within parent | Format: uri |
url | string | Required within parent | Format: uri |
verification | object | Required within parent | |
verification.payload | JSON | Required within parent | |
verification.payload (anyOf 1) | string | Alternative | |
verification.payload (anyOf 2) | null | Alternative | |
verification.reason | string | Required within parent | |
verification.signature | JSON | Required within parent | |
verification.signature (anyOf 1) | string | Alternative | |
verification.signature (anyOf 2) | null | Alternative | |
verification.verified | boolean | Required within parent | |
verification.verified_at | JSON | Required within parent | |
verification.verified_at (anyOf 1) | string | Alternative | |
verification.verified_at (anyOf 2) | null | Alternative |
Get a blob — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Blob |
content | string | Required within parent | |
encoding | string | Required within parent | |
highlighted_content | string | Optional | |
node_id | string | Required within parent | |
sha | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | JSON | Alternative | |
size (anyOf 1) (anyOf 1) | integer | Alternative | |
size (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
size (anyOf 2) | null | Alternative | |
url | string | Required within parent | Format: uri |
Get a reference — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Git references within a repository |
node_id | string | Required within parent | |
object | object | Required within parent | |
object.sha | string | Required within parent | SHA for the reference Maximum length: 40 Minimum length: 40 |
object.type | string | Required within parent | |
object.url | string | Required within parent | Format: uri |
ref | string | Required within parent | |
url | string | Required within parent | Format: uri |
Get a tag — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Metadata for a Git tag |
message | string | Required within parent | Message describing the purpose of the tag |
node_id | string | Required within parent | |
object | object | Required within parent | |
object.sha | string | Required within parent | |
object.type | string | Required within parent | |
object.url | string | Required within parent | Format: uri |
sha | string | Required within parent | |
tag | string | Required within parent | Name of the tag |
tagger | object | Required within parent | |
tagger.date | string | Required within parent | |
tagger.email | string | Required within parent | |
tagger.name | string | Required within parent | |
url | string | Required within parent | URL for the tag Format: uri |
verification | Model | Optional | Expand Get a tag — response body — verification |
Referenced models: Get a tag — response body — verification
Get a tag — response body — verification
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
payload | JSON | Required within parent | |
payload (anyOf 1) | string | Alternative | |
payload (anyOf 2) | null | Alternative | |
reason | string | Required within parent | |
signature | JSON | Required within parent | |
signature (anyOf 1) | string | Alternative | |
signature (anyOf 2) | null | Alternative | |
verified | boolean | Required within parent | |
verified_at | JSON | Required within parent | |
verified_at (anyOf 1) | string | Alternative | |
verified_at (anyOf 2) | null | Alternative |
Get a tree — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The hierarchy between files in a Git repository. |
sha | string | Required within parent | |
tree | array | Required within parent | Objects specifying a tree structure |
tree[] | object | Each item | |
tree[].mode | string | Required within parent | |
tree[].path | string | Required within parent | |
tree[].sha | string | Required within parent | |
tree[].size | JSON | Optional | |
tree[].size (anyOf 1) | integer | Alternative | |
tree[].size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
tree[].type | string | Required within parent | |
tree[].url | string | Optional | |
truncated | boolean | Required within parent | |
url | string | Optional | Format: uri |