GitHub: Licenses schemas
3 GitHub schemas with complete fields and constraints.
← Licenses operations · All schemas
Get a license — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | License |
body | string | Required within parent | |
conditions | array | Required within parent | |
conditions[] | string | Each item | |
description | string | Required within parent | |
featured | boolean | Required within parent | |
html_url | string | Required within parent | Format: uri |
implementation | string | Required within parent | |
key | string | Required within parent | |
limitations | array | Required within parent | |
limitations[] | string | Each item | |
name | string | Required within parent | |
node_id | string | Required within parent | |
permissions | array | Required within parent | |
permissions[] | string | Each item | |
spdx_id | JSON | Required within parent | |
spdx_id (anyOf 1) | string | Alternative | |
spdx_id (anyOf 2) | null | Alternative | |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | Format: uri |
url (anyOf 2) | null | Alternative |
Get all commonly used licenses — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | License Simple |
html_url | string | Optional | Format: uri |
key | string | Required within parent | |
name | string | Required within parent | |
node_id | string | Required within parent | |
spdx_id | JSON | Required within parent | |
spdx_id (anyOf 1) | string | Alternative | |
spdx_id (anyOf 2) | null | Alternative | |
url | JSON | Required within parent | |
url (anyOf 1) | string | Alternative | Format: uri |
url (anyOf 2) | null | Alternative |
Get the license for a repository — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | License Content |
_links | object | Required within parent | |
_links.git | JSON | Required within parent | |
_links.git (anyOf 1) | string | Alternative | Format: uri |
_links.git (anyOf 2) | null | Alternative | |
_links.html | JSON | Required within parent | |
_links.html (anyOf 1) | string | Alternative | Format: uri |
_links.html (anyOf 2) | null | Alternative | |
_links.self | string | Required within parent | Format: uri |
content | string | Required within parent | |
download_url | JSON | Required within parent | |
download_url (anyOf 1) | string | Alternative | Format: uri |
download_url (anyOf 2) | null | Alternative | |
encoding | string | Required within parent | |
git_url | JSON | Required within parent | |
git_url (anyOf 1) | string | Alternative | Format: uri |
git_url (anyOf 2) | null | Alternative | |
html_url | JSON | Required within parent | |
html_url (anyOf 1) | string | Alternative | Format: uri |
html_url (anyOf 2) | null | Alternative | |
license | Model | Required within parent | Expand Create a fork — response body — license |
name | string | Required within parent | |
path | string | Required within parent | |
sha | string | Required within parent | |
size | JSON | Required within parent | |
size (anyOf 1) | integer | Alternative | |
size (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | |
url | string | Required within parent | Format: uri |
Referenced models: Create a fork — response body — license