details

Creates, updates, deletes, gets or lists a details resource.

Overview

Name	details
Type	Resource
Id	github.repos.details

Fields

The following fields are returned by SELECT queries:

get

Response

Name	Datatype	Description
id	integer (int64)
name	string	(example: Hello-World)
node_id	string	(example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5)
full_name	string	(example: octocat/Hello-World)
allow_auto_merge	boolean
allow_forking	boolean
allow_merge_commit	boolean
allow_rebase_merge	boolean
allow_squash_merge	boolean
allow_update_branch	boolean
anonymous_access_enabled	boolean	Whether anonymous git access is allowed.
archive_url	string	(example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref})
archived	boolean
assignees_url	string	(example: http://api.github.com/repos/octocat/Hello-World/assignees{/user})
blobs_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha})
branches_url	string	(example: http://api.github.com/repos/octocat/Hello-World/branches{/branch})
clone_url	string	(example: https://github.com/octocat/Hello-World.git)
code_of_conduct	object	Code of Conduct Simple (title: Code Of Conduct Simple)
collaborators_url	string	(example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator})
comments_url	string	(example: http://api.github.com/repos/octocat/Hello-World/comments{/number})
commits_url	string	(example: http://api.github.com/repos/octocat/Hello-World/commits{/sha})
compare_url	string	(example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head})
contents_url	string	(example: http://api.github.com/repos/octocat/Hello-World/contents/{+path})
contributors_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/contributors)
created_at	string (date-time)	(example: 2011-01-26T19:01:12Z)
custom_properties	object	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.
default_branch	string	(example: master)
delete_branch_on_merge	boolean
deployments_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/deployments)
description	string	(example: This your first repo!)
disabled	boolean	Returns whether or not this repository disabled.
downloads_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/downloads)
events_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/events)
fork	boolean
forks	integer
forks_count	integer
forks_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/forks)
git_commits_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha})
git_refs_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha})
git_tags_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha})
git_url	string	(example: git:github.com/octocat/Hello-World.git)
has_discussions	boolean
has_downloads	boolean
has_issues	boolean
has_pages	boolean
has_projects	boolean
has_pull_requests	boolean
has_wiki	boolean
homepage	string (uri)	(example: https://github.com)
hooks_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/hooks)
html_url	string (uri)	(example: https://github.com/octocat/Hello-World)
is_template	boolean
issue_comment_url	string	(example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number})
issue_events_url	string	(example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number})
issues_url	string	(example: http://api.github.com/repos/octocat/Hello-World/issues{/number})
keys_url	string	(example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id})
labels_url	string	(example: http://api.github.com/repos/octocat/Hello-World/labels{/name})
language	string
languages_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/languages)
license	object	License Simple (title: License Simple)
master_branch	string
merge_commit_message	string	The default value for a merge commit message. - PR_TITLE - default to the pull request's title. - PR_BODY - default to the pull request's body. - BLANK - default to a blank commit message. (PR_BODY, PR_TITLE, BLANK) (example: PR_BODY)
merge_commit_title	string	The default value for a merge commit title. - PR_TITLE - default to the pull request's title. - MERGE_MESSAGE - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). (PR_TITLE, MERGE_MESSAGE) (example: PR_TITLE)
merges_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/merges)
milestones_url	string	(example: http://api.github.com/repos/octocat/Hello-World/milestones{/number})
mirror_url	string (uri)	(example: git:git.example.com/octocat/Hello-World)
network_count	integer
notifications_url	string	(example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating})
open_issues	integer
open_issues_count	integer
organization	object	A GitHub user. (title: Simple User)
owner	object	A GitHub user. (title: Simple User)
parent	object	A repository on GitHub. (title: Repository)
permissions	object
private	boolean
pull_request_creation_policy	string	The policy controlling who can create pull requests: all or collaborators_only. (all, collaborators_only) (example: all)
pulls_url	string	(example: http://api.github.com/repos/octocat/Hello-World/pulls{/number})
pushed_at	string (date-time)	(example: 2011-01-26T19:06:43Z)
releases_url	string	(example: http://api.github.com/repos/octocat/Hello-World/releases{/id})
security_and_analysis	object
size	integer	The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
source	object	A repository on GitHub. (title: Repository)
squash_merge_commit_message	string	The default value for a squash merge commit message: - PR_BODY - default to the pull request's body. - COMMIT_MESSAGES - default to the branch's commit messages. - BLANK - default to a blank commit message. (PR_BODY, COMMIT_MESSAGES, BLANK) (example: PR_BODY)
squash_merge_commit_title	string	The default value for a squash merge commit title: - PR_TITLE - default to the pull request's title. - COMMIT_OR_PR_TITLE - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). (PR_TITLE, COMMIT_OR_PR_TITLE) (example: PR_TITLE)
ssh_url	string	(example: git@github.com:octocat/Hello-World.git)
stargazers_count	integer
stargazers_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/stargazers)
statuses_url	string	(example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha})
subscribers_count	integer
subscribers_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/subscribers)
subscription_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/subscription)
svn_url	string (uri)	(example: https://svn.github.com/octocat/Hello-World)
tags_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/tags)
teams_url	string (uri)	(example: http://api.github.com/repos/octocat/Hello-World/teams)
temp_clone_token	string
template_repository	object	A repository on GitHub. (title: Repository)
topics	array
trees_url	string	(example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha})
updated_at	string (date-time)	(example: 2011-01-26T19:14:43Z)
url	string (uri)	(example: https://api.github.com/repos/octocat/Hello-World)
use_squash_pr_title_as_default	boolean
visibility	string	The repository visibility: public, private, or internal. (example: public)
watchers	integer
watchers_count	integer
web_commit_signoff_required	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	owner, repo		The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network. > [!NOTE] > - In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization." > - To view merge-related settings, you must have the contents:read and contents:write permissions.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

> [!NOTE]
> - In order to see the security_and_analysis block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "Managing security managers in your organization."
> - To view merge-related settings, you must have the contents:read and contents:write permissions.

SELECT
id,
name,
node_id,
full_name,
allow_auto_merge,
allow_forking,
allow_merge_commit,
allow_rebase_merge,
allow_squash_merge,
allow_update_branch,
anonymous_access_enabled,
archive_url,
archived,
assignees_url,
blobs_url,
branches_url,
clone_url,
code_of_conduct,
collaborators_url,
comments_url,
commits_url,
compare_url,
contents_url,
contributors_url,
created_at,
custom_properties,
default_branch,
delete_branch_on_merge,
deployments_url,
description,
disabled,
downloads_url,
events_url,
fork,
forks,
forks_count,
forks_url,
git_commits_url,
git_refs_url,
git_tags_url,
git_url,
has_discussions,
has_downloads,
has_issues,
has_pages,
has_projects,
has_pull_requests,
has_wiki,
homepage,
hooks_url,
html_url,
is_template,
issue_comment_url,
issue_events_url,
issues_url,
keys_url,
labels_url,
language,
languages_url,
license,
master_branch,
merge_commit_message,
merge_commit_title,
merges_url,
milestones_url,
mirror_url,
network_count,
notifications_url,
open_issues,
open_issues_count,
organization,
owner,
parent,
permissions,
private,
pull_request_creation_policy,
pulls_url,
pushed_at,
releases_url,
security_and_analysis,
size,
source,
squash_merge_commit_message,
squash_merge_commit_title,
ssh_url,
stargazers_count,
stargazers_url,
statuses_url,
subscribers_count,
subscribers_url,
subscription_url,
svn_url,
tags_url,
teams_url,
temp_clone_token,
template_repository,
topics,
trees_url,
updated_at,
url,
use_squash_pr_title_as_default,
visibility,
watchers,
watchers_count,
web_commit_signoff_required
FROM github.repos.details
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;