GitHub: Packages schemas

← Packages operations · All schemas

Get a package for a user — response body

Field	Type	Presence	Description and constraints
$	object	Root	A software package
created_at	string	Required within parent	Format: date-time
html_url	string	Required within parent
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the package.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Required within parent	The name of the package.
owner	Model	Optional	Expand Get an issue — response body — user
package_type	string	Required within parent	Known values: npm, maven, rubygems, docker, nuget, container
repository	Model	Optional	Expand Get a package for a user — response body — repository
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent
version_count	JSON	Required within parent
version_count (anyOf 1)	integer	Alternative	The number of versions of the package.
version_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
visibility	string	Required within parent	Known values: private, public

Referenced models: Get a package for a user — response body — repository, Get an issue — response body — user

Get a package for a user — response body — repository

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Get a package for a user — response body — repository / pull_request_creation_policy: all, collaborators only
$ (anyOf 2)	null	Alternative

Referenced models: Get a package for a user — response body — repository / pull_request_creation_policy: all, collaborators only

Get a package for a user — response body — repository / pull_request_creation_policy: all, collaborators only

Field	Type	Presence	Description and constraints
$	object	Root	Minimal Repository
allow_forking	boolean	Optional
archive_url	string	Required within parent
archived	boolean	Optional
assignees_url	string	Required within parent
blobs_url	string	Required within parent
branches_url	string	Required within parent
clone_url	string	Optional
code_of_conduct	Model	Optional	Expand Get a code of conduct — response body
collaborators_url	string	Required within parent
comments_url	string	Required within parent
commits_url	string	Required within parent
compare_url	string	Required within parent
contents_url	string	Required within parent
contributors_url	string	Required within parent	Format: uri
created_at	JSON	Optional
created_at (anyOf 1)	string	Alternative	Format: date-time
created_at (anyOf 2)	null	Alternative
custom_properties	object	Optional	The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. Additional keys: allowed
default_branch	string	Optional
delete_branch_on_merge	boolean	Optional
deployments_url	string	Required within parent	Format: uri
description	JSON	Required within parent
description (anyOf 1)	string	Alternative
description (anyOf 2)	null	Alternative
disabled	boolean	Optional
downloads_url	string	Required within parent	Format: uri
events_url	string	Required within parent	Format: uri
fork	boolean	Required within parent
forks	JSON	Optional
forks (anyOf 1)	integer	Alternative
forks (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forks_count	JSON	Optional
forks_count (anyOf 1)	integer	Alternative
forks_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
forks_url	string	Required within parent	Format: uri
full_name	string	Required within parent
git_commits_url	string	Required within parent
git_refs_url	string	Required within parent
git_tags_url	string	Required within parent
git_url	string	Optional
has_discussions	boolean	Optional
has_issues	boolean	Optional
has_pages	boolean	Optional
has_projects	boolean	Optional
has_pull_requests	boolean	Optional
has_wiki	boolean	Optional
homepage	JSON	Optional
homepage (anyOf 1)	string	Alternative
homepage (anyOf 2)	null	Alternative
hooks_url	string	Required within parent	Format: uri
html_url	string	Required within parent	Format: uri
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Format: int64
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_template	boolean	Optional
issue_comment_url	string	Required within parent
issue_events_url	string	Required within parent
issues_url	string	Required within parent
keys_url	string	Required within parent
labels_url	string	Required within parent
language	JSON	Optional
language (anyOf 1)	string	Alternative
language (anyOf 2)	null	Alternative
languages_url	string	Required within parent	Format: uri
license	JSON	Optional
license (anyOf 1)	object	Alternative
license (anyOf 1).key	string	Optional
license (anyOf 1).name	string	Optional
license (anyOf 1).node_id	string	Optional
license (anyOf 1).spdx_id	string	Optional
license (anyOf 1).url	JSON	Optional
license (anyOf 1).url (anyOf 1)	string	Alternative
license (anyOf 1).url (anyOf 2)	null	Alternative
license (anyOf 2)	null	Alternative
merges_url	string	Required within parent	Format: uri
milestones_url	string	Required within parent
mirror_url	JSON	Optional
mirror_url (anyOf 1)	string	Alternative
mirror_url (anyOf 2)	null	Alternative
name	string	Required within parent
network_count	JSON	Optional
network_count (anyOf 1)	integer	Alternative
network_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
node_id	string	Required within parent
notifications_url	string	Required within parent
open_issues	JSON	Optional
open_issues (anyOf 1)	integer	Alternative
open_issues (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
open_issues_count	JSON	Optional
open_issues_count (anyOf 1)	integer	Alternative
open_issues_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
owner	Model	Required within parent	Expand List users — response body — item
permissions	object	Optional
permissions.admin	boolean	Optional
permissions.maintain	boolean	Optional
permissions.pull	boolean	Optional
permissions.push	boolean	Optional
permissions.triage	boolean	Optional
private	boolean	Required within parent
pull_request_creation_policy	string	Optional	The policy controlling who can create pull requests: all or collaborators_only. Known values: all, collaborators_only
pulls_url	string	Required within parent
pushed_at	JSON	Optional
pushed_at (anyOf 1)	string	Alternative	Format: date-time
pushed_at (anyOf 2)	null	Alternative
releases_url	string	Required within parent
role_name	string	Optional
security_and_analysis	Model	Optional	Expand Create a fork — response body — security and analysis
size	JSON	Optional
size (anyOf 1)	integer	Alternative	The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ssh_url	string	Optional
stargazers_count	JSON	Optional
stargazers_count (anyOf 1)	integer	Alternative
stargazers_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
stargazers_url	string	Required within parent	Format: uri
statuses_url	string	Required within parent
subscribers_count	JSON	Optional
subscribers_count (anyOf 1)	integer	Alternative
subscribers_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subscribers_url	string	Required within parent	Format: uri
subscription_url	string	Required within parent	Format: uri
svn_url	string	Optional
tags_url	string	Required within parent	Format: uri
teams_url	string	Required within parent	Format: uri
temp_clone_token	string	Optional	When present and non-empty, a temporary credential for read-only Git access to this repository. It expires five minutes after generation and cannot be used to push changes. Treat this value as sensitive and avoid recording it in logs.
topics	array	Optional
topics[]	string	Each item
trees_url	string	Required within parent
updated_at	JSON	Optional
updated_at (anyOf 1)	string	Alternative	Format: date-time
updated_at (anyOf 2)	null	Alternative
url	string	Required within parent	Format: uri
visibility	string	Optional
watchers	JSON	Optional
watchers (anyOf 1)	integer	Alternative
watchers (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
watchers_count	JSON	Optional
watchers_count (anyOf 1)	integer	Alternative
watchers_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
web_commit_signoff_required	boolean	Optional

Referenced models: Get a code of conduct — response body, Create a fork — response body — security and analysis, List users — response body — item

Get a package version for a user — response body

Field	Type	Presence	Description and constraints
$	object	Root	A version of a software package
created_at	string	Required within parent	Format: date-time
deleted_at	string	Optional	Format: date-time
description	string	Optional
html_url	string	Optional
id	JSON	Required within parent
id (anyOf 1)	integer	Alternative	Unique identifier of the package version.
id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
license	string	Optional
metadata	object	Optional
metadata.container	object	Optional
metadata.container.tags	array	Required within parent
metadata.container.tags[]	string	Each item
metadata.docker	object	Optional
metadata.docker.tag	array	Optional
metadata.docker.tag[]	string	Each item
metadata.package_type	string	Required within parent	Known values: npm, maven, rubygems, docker, nuget, container
name	string	Required within parent	The name of the package version.
package_html_url	string	Required within parent
updated_at	string	Required within parent	Format: date-time
url	string	Required within parent