Concepts

Concepts used in GitHub BDK Book.

Github issue

GitHub Issue Wrapper class.

Field Name	Description	Type
number	The number of the issue. Optional since is None in case of creating an issue.	optional[number]
title	The title of the issue. Optional since can be None in case of editing an issue.	optional[text]
body	The body of the issue. Optional since can be None in case of editing an issue.	optional[text]
state	The state of the issue. Optional since is None in case of creating an issue.	optional[text]
labels	The labels of the issue. Optional since can be None in case of editing an issue.	optional[list of github label]
user	The user of the issue. Optional since is None in case of creating an issue.	optional[github user]

Github label

GitHub Label Wrapper class.

Field Name	Description	Type
color	The color of the label.	text
description	The description of the label.	optional[text]
name	The name of the label.	text
url	The URL of the label.	text

Github user

GitHub User Wrapper class.

Field Name	Description	Type
login	The login of the user.	optional[text]
id	The ID of the user.	optional[number]
type	The type of the user.	optional[text]

Github pull request

GitHub Pull Request Wrapper class.

Field Name	Description	Type
number	The number of the pull request. Optional since is None in case of creating a pull request.	optional[number]
head	The head of the pull request. Optional since can be None in case of editing a pull request.	optional[github pull request part]
title	The title of the pull request. Optional since can be None in case of editing a pull request.	optional[text]
base	The base of the pull request. Optional since can be None in case of editing a pull request.	optional[github pull request part]
body	The body of the pull request. Optional since can be None in case of editing a pull request.	optional[text]
state	The state of the pull request. Optional since is None in case of creating a pull request.	optional[text]

Github pull request part

GitHub Pull Request Part Wrapper class.

Field Name	Description	Type
label	The label of the pull request part.	optional[text]
ref	The reference of the pull request part.	optional[text]
sha	The SHA of the pull request part.	optional[text]

Github commit

GitHub Commit Wrapper class.

Field Name	Description	Type
commit	The commit.	optional[git commit]
sha	The SHA of the commit.	optional[text]
stats	The commit stats.	optional[github commit stats]
url	The URL of the commit.	optional[text]

Git commit

GitHub Git Commit Wrapper class.

Field Name	Description	Type
author	The author of the commit.	optional[git author]
committer	The committer of the commit.	optional[git author]
message	The message of the commit.	optional[text]
sha	The SHA of the commit.	optional[text]

Github commit stats

GitHub Commit Stats Wrapper class.

Field Name	Description	Type
total	The total number of commits.	number
deletions	The number of deletions.	number
additions	The number of additions.	number

Github repository

GitHub Repository Wrapper class.

Field Name	Description	Type
branches_url	The branches URL.	text
commits_url	The commits URL.	text
description	The description of the repository.	text
git_commits_url	The git commits URL.	text
git_tags_url	The git tags URL.	text
git_url	The git URL.	text
name	The name of the repository.	text

Github team

GitHub Team Wrapper class.

Field Name	Description	Type
id	The ID of the team.	number
url	The URL of the team.	text
name	The name of the team.	text
slug	The slug of the team.	text
description	The description of the team.	text
privacy	The privacy of the team.	text
permission	The permission of the team.	text
members	The members of the team.	optional[list of github user]
members_url	The members URL of the team.	optional[text]
repositories_url	The repositories URL of the team.	text