Could be access directly from GitHubClient->activity
- GitHubActivityEvents events
- GitHubActivityFeeds feeds
- GitHubActivityNotifications notifications
- GitHubActivitySettings settings
- GitHubActivityStarring starring
- GitHubActivityWatching watching
- GitHubActivityEvents events
- GitHubActivityFeeds feeds
- GitHubActivityNotifications notifications
- GitHubActivitySettings settings
- GitHubActivityStarring starring
- GitHubActivityWatching watching
Could be access directly from GitHubClient->Activity->activityEvents
- GitHubActivityEventsTypes types
- GitHubActivityEventsTypes types
Could be access directly from GitHubClient->ActivityEvents->activityEventsTypes
Could be access directly from GitHubClient->Activity->activityFeeds
listFeeds:
Expected HTTP status: 200 List Feeds
Attributes:
Returns GitHubFeeds object
Could be access directly from GitHubClient->Activity->activityNotifications
listYourNotifications:
Expected HTTP status: 200 List your notifications
Attributes:
- boolean parameterName (Optional)
true
to show notifications marked as read. - boolean parameterName (Optional)
true
to show only notifications in which the user is- directly participating or mentioned.
- time parameterName (Optional) filters out any notifications updated before the given
- time. The time should be passed in as UTC in the ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
. Example: "2012-10-09T23:39:01Z".
Returns array of GitHubThread objects
listYourNotificationsInRepository:
Expected HTTP status: 200 List your notifications in a repository
Attributes:
- boolean parameterName (Optional)
true
to show notifications marked as read. - boolean parameterName (Optional)
true
to show only notifications in which the user is- directly participating or mentioned.
- time parameterName (Optional) filters out any notifications updated before the given
- time. The time should be passed in as UTC in the ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ
. Example: "2012-10-09T23:39:01Z".
Returns array of GitHubThread objects
markAsRead:
Expected HTTP status: 205 Mark as read
Attributes:
- Time parameterName (Optional) Describes the last point that notifications were checked. Anything
- updated since this time will not be updated. Default: Now. Expected in ISO
- 8601 format:
YYYY-MM-DDTHH:MM:SSZ
. Example: "2012-10-09T23:39:01Z".
markNotificationsAsReadInRepository:
Expected HTTP status: 205 Mark notifications as read in a repository
Attributes:
- Time parameterName (Optional) Describes the last point that notifications were checked. Anything
- updated since this time will not be updated. Default: Now. Expected in ISO
- 8601 format:
YYYY-MM-DDTHH:MM:SSZ
. Example: "2012-10-09T23:39:01Z".
viewSingleThread:
Expected HTTP status: 200 View a single thread
Attributes:
Returns array of GitHubThread objects
markThreadAsRead:
Expected HTTP status: 205 Mark a thread as read
Attributes:
getThreadSubscription:
Expected HTTP status: 200 Get a Thread Subscription
Attributes:
Returns GitHubSubscription object
setThreadSubscription:
Expected HTTP status: 200 Set a Thread Subscription
Attributes:
Returns GitHubSubscription object
deleteThreadSubscription:
Expected HTTP status: 204 Delete a Thread Subscription
Attributes:
Could be access directly from GitHubClient->Activity->activitySettings
Could be access directly from GitHubClient->Activity->activityStarring
listStargazers:
Expected HTTP status: 204 List Stargazers
Attributes:
Could be access directly from GitHubClient->Activity->activityWatching
listWatchers:
Expected HTTP status: 200 List watchers
Attributes:
Returns GitHubRepoSubscription object
setRepositorySubscription:
Expected HTTP status: 200 Set a Repository Subscription
Attributes:
Returns GitHubRepoSubscription object
deleteRepositorySubscription:
Expected HTTP status: 204 Delete a Repository Subscription
Attributes:
checkIfYouAreWatchingRepositoryLegacy:
Expected HTTP status: 204 Check if you are watching a repository (LEGACY)
Attributes:
Could be access directly from GitHubClient->changelog
Could be access directly from GitHubClient->gists
- GitHubGistsComments comments
- GitHubGistsComments comments
authentication:
Expected HTTP status: 200 Authentication
Attributes:
Returns GitHubFullGist object
createGist:
Expected HTTP status: 200 Create a gist
Attributes:
- hash parameterName (Optional) - Files that make up this gist. The key of which
- should be an optional string filename and the value another
- optional hash with parameters:
Returns GitHubFullGist object
starGist:
Expected HTTP status: 204 Star a gist
Attributes:
unstarGist:
Expected HTTP status: 204 Unstar a gist
Attributes:
checkIfGistIsStarred:
Expected HTTP status: 204 Check if a gist is starred
Attributes:
Could be access directly from GitHubClient->Gists->gistsComments
listCommentsOnGist:
Expected HTTP status: 200 List comments on a gist
Attributes:
Returns array of GitHubGistComment objects
getSingleComment:
Expected HTTP status: 200 Get a single comment
Attributes:
Returns GitHubGistComment object
createComment:
Expected HTTP status: 200 Create a comment
Attributes:
Returns GitHubGistComment object
deleteComment:
Expected HTTP status: 204 Delete a comment
Attributes:
Could be access directly from GitHubClient->git
- GitHubGitBlobs blobs
- GitHubGitCommits commits
- GitHubGitImport import
- GitHubGitRefs refs
- GitHubGitTags tags
- GitHubGitTrees trees
- GitHubGitBlobs blobs
- GitHubGitCommits commits
- GitHubGitImport import
- GitHubGitRefs refs
- GitHubGitTags tags
- GitHubGitTrees trees
Could be access directly from GitHubClient->Git->gitBlobs
getBlob:
Expected HTTP status: 200 Get a Blob
Attributes:
Returns array of GitHubBlob objects
Could be access directly from GitHubClient->Git->gitCommits
getCommit:
Expected HTTP status: 200 Get a Commit
Attributes:
Returns GitHubGitCommit object
Could be access directly from GitHubClient->Git->gitImport
Could be access directly from GitHubClient->Git->gitRefs
getReference:
Expected HTTP status: 200 Get a Reference
Attributes:
Returns GitHubRef object
getAllReferences:
Expected HTTP status: 204 Get all References
Attributes:
Could be access directly from GitHubClient->Git->gitTags
getTag:
Expected HTTP status: 200 Get a Tag
Attributes:
Returns GitHubGittag object
Could be access directly from GitHubClient->Git->gitTrees
getTree:
Expected HTTP status: 200 Get a Tree
Attributes:
Returns GitHubTree object
getTreeRecursively:
Expected HTTP status: 200 Get a Tree Recursively
Attributes:
Returns GitHubTreeExtra object
Could be access directly from GitHubClient->gitignore
listingAvailableTemplates:
Expected HTTP status: 200 Listing available templates
Attributes:
Returns array of GitHubTemplates objects
getSingleTemplate:
Expected HTTP status: 200 Get a single template
Attributes:
Returns array of GitHubTemplate objects
Could be access directly from GitHubClient->issues
- GitHubIssuesAssignees assignees
- GitHubIssuesComments comments
- GitHubIssuesEvents events
- GitHubIssuesLabels labels
- GitHubIssuesMilestones milestones
- GitHubIssuesAssignees assignees
- GitHubIssuesComments comments
- GitHubIssuesEvents events
- GitHubIssuesLabels labels
- GitHubIssuesMilestones milestones
listIssues:
Expected HTTP status: 200 List issues
Attributes:
Returns GitHubIssue object
createAnIssue:
Expected HTTP status: 200 Create an issue
Attributes:
- string parameterName (Optional) - Login for the user that this issue should be
- assigned to.
- string parameterName (Optional) - State of the issue:
open
orclosed
. - number parameterName (Optional) - Milestone to associate this issue with.
- array parameterName (Optional) of strings - Labels to associate with this
- issue. Pass one or more Labels to replace the set of Labels on this
- Issue. Send an empty array (
[]
) to clear all Labels from the Issue.
Returns GitHubIssue object
Could be access directly from GitHubClient->Issues->issuesAssignees
listAssignees:
Expected HTTP status: 200 List assignees
Attributes:
Returns array of GitHubUser objects
Could be access directly from GitHubClient->Issues->issuesComments
listCommentsOnAnIssue:
Expected HTTP status: 200 List comments on an issue
Attributes:
- String parameterName (Optional)
created
orupdated
- String parameterName (Optional)
asc
ordesc
. Ignored withoutsort
parameter. - String parameterName (Optional) of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
Returns array of GitHubPullComment objects
getSingleComment:
Expected HTTP status: 200 Get a single comment
Attributes:
Returns GitHubIssueComment object
createComment:
Expected HTTP status: 200 Create a comment
Attributes:
Returns GitHubIssueComment object
deleteComment:
Expected HTTP status: 204 Delete a comment
Attributes:
Could be access directly from GitHubClient->Issues->issuesEvents
attributes:
Expected HTTP status: 200 Attributes
Attributes:
Returns GitHubFullIssueEvent object
Could be access directly from GitHubClient->Issues->issuesLabels
listAllLabelsForThisRepository:
Expected HTTP status: 200 List all labels for this repository
Attributes:
Returns array of GitHubLabel objects
getSingleLabel:
Expected HTTP status: 200 Get a single label
Attributes:
Returns GitHubLabel object
createLabel:
Expected HTTP status: 204 Create a label
Attributes:
listLabelsOnAnIssue:
Expected HTTP status: 200 List labels on an issue
Attributes:
Returns array of GitHubLabel objects
addLabelsToAnIssue:
Expected HTTP status: 204 Add labels to an issue
Attributes:
replaceAllLabelsForAnIssue:
Expected HTTP status: 200 Replace all labels for an issue
Attributes:
Returns array of GitHubLabel objects
removeAllLabelsFromAnIssue:
Expected HTTP status: 204 Remove all labels from an issue
Attributes:
Could be access directly from GitHubClient->Issues->issuesMilestones
listMilestonesForRepository:
Expected HTTP status: 200 List milestones for a repository
Attributes:
Returns GitHubMilestone object
createMilestone:
Expected HTTP status: 200 Create a milestone
Attributes:
- string parameterName (Optional) -
open
orclosed
. Default isopen
. - string parameterName (Optional) - ISO 8601 time.
Returns GitHubMilestone object
deleteMilestone:
Expected HTTP status: 204 Delete a milestone
Attributes:
Could be access directly from GitHubClient->libraries
getTextAsMarkdown:
Expected HTTP status: 200 Render an arbitrary Markdown document
Attributes:
- String text (Required) markdown text to process
- String mode (Optional)
markdown
orgfm
. Defaults tomarkdown
- String context (Optional) the repository context. Only taken into account when rendering as gfm
Returns text/html
Could be access directly from GitHubClient->media
Could be access directly from GitHubClient->meta
Could be access directly from GitHubClient->oauth
webApplicationFlow:
Expected HTTP status: 200 Web Application Flow
Attributes:
Returns GitHubOauthAccess object
createNewAuthorization:
Expected HTTP status: 200 Create a new authorization
Attributes:
- array parameterName (Optional) - Replaces the authorization scopes with these.
- array parameterName (Optional) - A list of scopes to add to this authorization.
- array parameterName (Optional) - A list of scopes to remove from this
- authorization.
- string parameterName (Optional) - A note to remind you what the OAuth token is for.
- string parameterName (Optional) - A URL to remind you what app the OAuth token is for.
Returns GitHubOauthAccess object
deleteAnAuthorization:
Expected HTTP status: 204 Delete an authorization
Attributes:
checkAnAuthorization:
Expected HTTP status: 200 Check an authorization
Attributes:
Returns array of GitHubOauthAccessWithUser objects
Could be access directly from GitHubClient->orgs
- GitHubOrgsMembers members
- GitHubOrgsTeams teams
- GitHubOrgsMembers members
- GitHubOrgsTeams teams
listUserOrganizations:
Expected HTTP status: 200 List User Organizations
Attributes:
Returns array of GitHubFullOrg objects
Could be access directly from GitHubClient->Orgs->orgsMembers
membersList:
Expected HTTP status: 200 Members list
Attributes:
Returns array of GitHubUser objects
removeMember:
Expected HTTP status: 204 Remove a member
Attributes:
publicMembersList:
Expected HTTP status: 200 Public members list
Attributes:
Returns array of GitHubUser objects
checkPublicMembership:
Expected HTTP status: 204 Check public membership
Attributes:
Could be access directly from GitHubClient->Orgs->orgsTeams
listTeams:
Expected HTTP status: 200 List teams
Attributes:
Returns array of GitHubTeam objects
getTeam:
Expected HTTP status: 200 Get team
Attributes:
Returns array of GitHubFullTeam objects
createTeam:
Expected HTTP status: 200 Create team
Attributes:
Returns array of GitHubFullTeam objects
deleteTeam:
Expected HTTP status: 204 Delete team
Attributes:
listTeamMembers:
Expected HTTP status: 200 List team members
Attributes:
Returns array of GitHubUser objects
getTeamMember:
Expected HTTP status: 204 Get team member
Attributes:
removeTeamMember:
Expected HTTP status: 204 Remove team member
Attributes:
listTeamRepos:
Expected HTTP status: 200 List team repos
Attributes:
Returns array of GitHubRepo objects
getTeamRepo:
Expected HTTP status: 204 Get team repo
Attributes:
removeTeamRepo:
Expected HTTP status: 204 Remove team repo
Attributes:
Could be access directly from GitHubClient->pulls
- GitHubPullsComments comments
- GitHubPullsComments comments
linkRelations:
Expected HTTP status: 200 Link Relations
Attributes:
- string parameterName (Optional) -
open
orclosed
to filter by state. Default- is
open
.
- is
- string parameterName (Optional) - Filter pulls by head user and branch name in the format
- of:
user:ref-name
. Example:github:new-script-format
.
- of:
- string parameterName (Optional) - Filter pulls by base branch name. Example:
gh-pages
.
Returns array of GitHubPull objects
getSinglePullRequest:
Expected HTTP status: 200 Get a single pull request
Attributes:
Returns GitHubFullPull object
mergability:
Expected HTTP status: 200 Mergability
Attributes:
- string parameterName (Optional) - State of this Pull Request. Valid values are
open
andclosed
.
Returns GitHubPull object
listCommitsOnPullRequest:
Expected HTTP status: 200 List commits on a pull request
Attributes:
Returns array of GitHubCommit objects
listPullRequestsFiles:
Expected HTTP status: 200 List pull requests files
Attributes:
Returns array of GitHubFile objects
Could be access directly from GitHubClient->Pulls->pullsComments
listCommentsOnPullRequest:
Expected HTTP status: 200 List comments on a pull request
Attributes:
Returns array of GitHubPullComment objects
listCommentsInRepository:
Expected HTTP status: 200 List comments in a repository
Attributes:
- String parameterName (Optional)
created
orupdated
- String parameterName (Optional)
asc
ordesc
. Ignored withoutsort
parameter. - String parameterName (Optional) of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
Returns array of GitHubPullComment objects
getSingleComment:
Expected HTTP status: 200 Get a single comment
Attributes:
Returns GitHubPullComment object
createComment:
Expected HTTP status: 204 Create a comment
Attributes:
Could be access directly from GitHubClient->repos
- GitHubReposCollaborators collaborators
- GitHubReposComments comments
- GitHubReposCommits commits
- GitHubReposContents contents
- GitHubReposDownloads downloads
- GitHubReposForks forks
- GitHubReposHooks hooks
- GitHubReposKeys keys
- GitHubReposMerging merging
- GitHubReposStatistics statistics
- GitHubReposStatuses statuses
- GitHubReposCollaborators collaborators
- GitHubReposComments comments
- GitHubReposCommits commits
- GitHubReposContents contents
- GitHubReposDownloads downloads
- GitHubReposForks forks
- GitHubReposHooks hooks
- GitHubReposKeys keys
- GitHubReposMerging merging
- GitHubReposStatistics statistics
- GitHubReposStatuses statuses
listYourRepositories:
Expected HTTP status: 200 List your repositories
Attributes:
Returns array of GitHubSimpleRepo objects
create:
Expected HTTP status: 200 Create
Attributes:
- boolean parameterName (Optional) -
true
makes the repository private, andfalse
makes it public.
- boolean parameterName (Optional) -
true
to enable issues for this repository,false
to disable them. Default istrue
.
- boolean parameterName (Optional) -
true
to enable the wiki for this- repository,
false
to disable it. Default istrue
.
- repository,
- boolean parameterName (Optional) -
true
to enable downloads for this- repository,
false
to disable them. Default istrue
.
- repository,
- String parameterName (Optional) - Update the default branch for this repository.
Returns GitHubFullRepo object
listContributors:
Expected HTTP status: 200 List contributors
Attributes:
Returns array of GitHubContributor objects
listLanguages:
Expected HTTP status: 200 List languages
Attributes:
Returns array of GitHubTeam objects
listTags:
Expected HTTP status: 200 List Tags
Attributes:
Returns array of GitHubTag objects
listBranches:
Expected HTTP status: 200 List Branches
Attributes:
Returns array of GitHubBranches objects
getBranch:
Expected HTTP status: 200 Get Branch
Attributes:
Returns array of GitHubBranch objects
deleteRepository:
Expected HTTP status: 204 Delete a Repository
Attributes:
Could be access directly from GitHubClient->Repos->reposCollaborators
listReposCollaborators:
Expected HTTP status: 200 List
Attributes:
Returns array of GitHubUser objects
get:
Expected HTTP status: 204 Get
Attributes:
Could be access directly from GitHubClient->Repos->reposComments
listCommitCommentsForRepository:
Expected HTTP status: 200 List commit comments for a repository
Attributes:
Returns array of GitHubCommitComment objects
listCommentsForSingleCommit:
Expected HTTP status: 200 List comments for a single commit
Attributes:
Returns array of GitHubCommitComment objects
createCommitComment:
Expected HTTP status: 200 Create a commit comment
Attributes:
Returns GitHubCommitComment object
updateCommitComment:
Expected HTTP status: 204 Update a commit comment
Attributes:
Could be access directly from GitHubClient->Repos->reposCommits
listCommitsOnRepository:
Expected HTTP status: 200 List commits on a repository
Attributes:
- string parameterName (Optional) - Sha or branch to start listing commits from.
- string parameterName (Optional) - Only commits containing this file path
- will be returned.
- string parameterName (Optional) - GitHub login, name, or email by which to filter by
- commit author
- ISO 8601 Date parameterName (Optional) - Only commits after this date will be returned
- ISO 8601 Date parameterName (Optional) - Only commits before this date will be returned
Returns array of GitHubCommit objects
getSingleCommit:
Expected HTTP status: 200 Get a single commit
Attributes:
Returns array of GitHubFullCommit objects
compareTwoCommits:
Expected HTTP status: 200 Compare two commits
Attributes:
Returns GitHubCommitComparison object
Could be access directly from GitHubClient->Repos->reposContents
getTheReadme:
Expected HTTP status: 200 Get the README
Attributes:
- string parameterName (Optional) - The String name of the Commit/Branch/Tag. Defaults to
master
.
Returns GitHubReadmeContent object
Could be access directly from GitHubClient->Repos->reposDownloads
listDownloadsForRepository:
Expected HTTP status: 200 List downloads for a repository
Attributes:
Returns array of GitHubDownload objects
getSingleDownload:
Expected HTTP status: 200 Get a single download
Attributes:
Returns GitHubDownload object
Could be access directly from GitHubClient->Repos->reposForks
listForks:
Expected HTTP status: 200 List forks
Attributes:
Returns array of GitHubRepo objects
Could be access directly from GitHubClient->Repos->reposHooks
listReposHooks:
Expected HTTP status: 200 List
Attributes:
Returns GitHubHook object
createHook:
Expected HTTP status: 204 Create a hook
Attributes:
Could be access directly from GitHubClient->Repos->reposKeys
listReposKeys:
Expected HTTP status: 200 List
Attributes:
Returns array of GitHubPublicKey objects
get:
Expected HTTP status: 200 Get
Attributes:
Returns GitHubPublicKey object
create:
Expected HTTP status: 200 Create
Attributes:
Returns GitHubPublicKey object
Could be access directly from GitHubClient->Repos->reposMerging
Could be access directly from GitHubClient->Repos->reposStatistics
aWordAboutCaching:
Expected HTTP status: 200 A word about caching
Attributes:
Returns array of GitHubRepoStatsContributors objects
getTheLastYearOfCommitActivityData:
Expected HTTP status: 200 Get the last year of commit activity data
Attributes:
Returns array of GitHubRepoStatsCommitActivity objects
Could be access directly from GitHubClient->Repos->reposStatuses
listStatusesForSpecificRef:
Expected HTTP status: 200 List Statuses for a specific Ref
Attributes:
- string parameterName (Required) - Ref to list the statuses from. It can be a SHA, a branch name, or a tag name.
Returns array of GitHubStatus objects
Could be access directly from GitHubClient->search
Could be access directly from GitHubClient->users
- GitHubUsersEmails emails
- GitHubUsersFollowers followers
- GitHubUsersKeys keys
- GitHubUsersEmails emails
- GitHubUsersFollowers followers
- GitHubUsersKeys keys
getSingleUser:
Expected HTTP status: 200 Get a single user
Attributes:
Returns GitHubFullUser object
getTheAuthenticatedUser:
Expected HTTP status: 200 Get the authenticated user
Attributes:
Returns GitHubPrivateUser object
updateTheAuthenticatedUser:
Expected HTTP status: 200 Update the authenticated user
Attributes:
- string parameterName (Optional) - Publicly visible email address.
Returns GitHubPrivateUser object
getAllUsers:
Expected HTTP status: 200 Get all users
Attributes:
Returns array of GitHubUser objects
Could be access directly from GitHubClient->Users->usersEmails
listEmailAddressesForUser:
Expected HTTP status: 204 List email addresses for a user
Attributes:
Could be access directly from GitHubClient->Users->usersFollowers
listFollowersOfUser:
Expected HTTP status: 204 List followers of a user
Attributes:
Could be access directly from GitHubClient->Users->usersKeys
listPublicKeysForUser:
Expected HTTP status: 200 List public keys for a user
Attributes:
Returns array of GitHubSimplePublicKey objects
listYourPublicKeys:
Expected HTTP status: 200 List your public keys
Attributes:
Returns array of GitHubPublicKey objects
getSinglePublicKey:
Expected HTTP status: 200 Get a single public key
Attributes:
Returns GitHubPublicKey object
createPublicKey:
Expected HTTP status: 200 Create a public key
Attributes:
Returns GitHubPublicKey object