GitHub: Gists schemas

← Gists operations · All schemas

Fork a gist — response body

Field	Type	Presence	Description and constraints
$	object	Root	Base Gist
comments	JSON	Required within parent
comments (anyOf 1)	integer	Alternative
comments (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comments_enabled	boolean	Optional
comments_url	string	Required within parent	Format: uri
commits_url	string	Required within parent	Format: uri
created_at	string	Required within parent	Format: date-time
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
files	object	Required within parent	Additional keys: see wildcard field
files.*	object	Additional keys
files.*.encoding	string	Optional	The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. Default: utf-8
files.*.filename	string	Optional
files.*.language	string	Optional
files.*.raw_url	string	Optional
files.*.size	JSON	Optional
files.*.size (anyOf 1)	integer	Alternative
files.*.size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
files.*.type	string	Optional
forks_url	string	Required within parent	Format: uri
git_pull_url	string	Required within parent	Format: uri
git_push_url	string	Required within parent	Format: uri
html_url	string	Required within parent	Format: uri
id	string	Required within parent
node_id	string	Required within parent
owner	Model	Optional	Expand List users — response body — item
public	boolean	Required within parent
truncated	boolean	Optional
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri

Referenced models: List users — response body — item

Get a gist comment — response body

Field	Type	Presence	Description and constraints
$	object	Root	A comment made to a gist.
author_association	string	Required within parent	How the author is associated with the repository. Known values: COLLABORATOR, CONTRIBUTOR, FIRST_TIMER, FIRST_TIME_CONTRIBUTOR, MANNEQUIN, MEMBER, NONE, OWNER
body	string	Required within parent	The comment text. Maximum length: 65535
created_at	string	Required within parent	Format: date-time
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
node_id	string	Required within parent
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri
user	Model	Required within parent	Expand Get an issue — response body — user

Referenced models: Get an issue — response body — user

Get a gist — response body

Field	Type	Presence	Description and constraints
$	object	Root	Gist Simple
comments	JSON	Optional
comments (anyOf 1)	integer	Alternative
comments (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
comments_enabled	boolean	Optional
comments_url	string	Optional
commits_url	string	Optional
created_at	string	Optional
description	JSON	Optional
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
files	object	Optional	Additional keys: see wildcard field
files.*	JSON	Additional keys
files.* (anyOf 1)	object	Alternative
files.* (anyOf 1).content	string	Optional
files.* (anyOf 1).encoding	string	Optional	The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. Default: utf-8
files.* (anyOf 1).filename	string	Optional
files.* (anyOf 1).language	string	Optional
files.* (anyOf 1).raw_url	string	Optional
files.* (anyOf 1).size	JSON	Optional
files.* (anyOf 1).size (anyOf 1)	integer	Alternative
files.* (anyOf 1).size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
files.* (anyOf 1).truncated	boolean	Optional
files.* (anyOf 1).type	string	Optional
files.* (anyOf 2)	null	Alternative
fork_of	JSON	Optional
fork_of (anyOf 1)	object	Alternative	Gist
fork_of (anyOf 1).comments	JSON	Required within parent
fork_of (anyOf 1).comments (anyOf 1)	integer	Alternative
fork_of (anyOf 1).comments (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fork_of (anyOf 1).comments_enabled	boolean	Optional
fork_of (anyOf 1).comments_url	string	Required within parent	Format: uri
fork_of (anyOf 1).commits_url	string	Required within parent	Format: uri
fork_of (anyOf 1).created_at	string	Required within parent	Format: date-time
fork_of (anyOf 1).description	JSON	Required within parent
fork_of (anyOf 1).description (anyOf 1)	string	Alternative
fork_of (anyOf 1).description (anyOf 2)	null	Alternative
fork_of (anyOf 1).files	object	Required within parent	Additional keys: see wildcard field
fork_of (anyOf 1).files.*	object	Additional keys
fork_of (anyOf 1).files.*.filename	string	Optional
fork_of (anyOf 1).files.*.language	string	Optional
fork_of (anyOf 1).files.*.raw_url	string	Optional
fork_of (anyOf 1).files.*.size	JSON	Optional
fork_of (anyOf 1).files.*.size (anyOf 1)	integer	Alternative
fork_of (anyOf 1).files.*.size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fork_of (anyOf 1).files.*.type	string	Optional
fork_of (anyOf 1).forks	array	Optional
fork_of (anyOf 1).forks[]	JSON	Each item
fork_of (anyOf 1).forks_url	string	Required within parent	Format: uri
fork_of (anyOf 1).git_pull_url	string	Required within parent	Format: uri
fork_of (anyOf 1).git_push_url	string	Required within parent	Format: uri
fork_of (anyOf 1).history	array	Optional
fork_of (anyOf 1).history[]	JSON	Each item
fork_of (anyOf 1).html_url	string	Required within parent	Format: uri
fork_of (anyOf 1).id	string	Required within parent
fork_of (anyOf 1).node_id	string	Required within parent
fork_of (anyOf 1).owner	Model	Optional	Expand Get an issue — response body — user
fork_of (anyOf 1).public	boolean	Required within parent
fork_of (anyOf 1).truncated	boolean	Optional
fork_of (anyOf 1).updated_at	string	Required within parent	Format: date-time
fork_of (anyOf 1).url	string	Required within parent	Format: uri
fork_of (anyOf 1).user	Model	Required within parent	Expand Get an issue — response body — user
fork_of (anyOf 2)	null	Alternative
forks_url	string	Optional
git_pull_url	string	Optional
git_push_url	string	Optional
html_url	string	Optional
id	string	Optional
node_id	string	Optional
owner	Model	Optional	Expand List users — response body — item
public	boolean	Optional
truncated	boolean	Optional
updated_at	string	Optional
url	string	Optional
user	JSON	Optional
user (anyOf 1)	string	Alternative
user (anyOf 2)	null	Alternative

Referenced models: Get an issue — response body — user, List users — response body — item

List gist commits — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Gist Commit
change_status	object	Required within parent
change_status.additions	JSON	Optional
change_status.additions (anyOf 1)	integer	Alternative
change_status.additions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
change_status.deletions	JSON	Optional
change_status.deletions (anyOf 1)	integer	Alternative
change_status.deletions (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
change_status.total	JSON	Optional
change_status.total (anyOf 1)	integer	Alternative
change_status.total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
committed_at	string	Required within parent	Format: date-time
url	string	Required within parent	Format: uri
user	Model	Required within parent	Expand Get an issue — response body — user
version	string	Required within parent

Referenced models: Get an issue — response body — user