GitHub

This module re-exports all request constructrors and data definitions from this package.

See GitHub.Request module for executing Request, or other modules of this package (e.g. GitHub.Users) for already composed versions.

The missing endpoints lists show which endpoints we know are missing, there might be more.

Activity

See https://developer.github.com/v3/activity/

Starring

See https://developer.github.com/v3/activity/starring/

Missing endpoints:

• Check if you are starring a repository
• Star a repository
• Unstar a repository

stargazersForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector SimpleUser)

List Stargazers. See https://developer.github.com/v3/activity/starring/#list-stargazers

reposStarredByR :: Name Owner -> Maybe Count -> Request k (Vector Repo)

List repositories being starred. See https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

myStarredR :: Maybe Count -> Request True (Vector Repo)

All the repos starred by the authenticated user.

Watching

See https://developer.github.com/v3/activity/

Missing endpoints:

• Query a Repository Subscription
• Set a Repository Subscription
• Delete a Repository Subscription

watchersForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector SimpleUser)

List watchers. See https://developer.github.com/v3/activity/watching/#list-watchers

reposWatchedByR :: Name Owner -> Maybe Count -> Request k (Vector Repo)

List repositories being watched. See https://developer.github.com/v3/activity/watching/#list-repositories-being-watched

Gists

See https://developer.github.com/v3/gists/

Missing endpoints:

• Query a specific revision of a gist
• Create a gist
• Edit a gist
• List gist commits
• Star a gist
• Unstar a gist
• Check if a gist is starred
• Fork a gist
• List gist forks
• Delete a gist

gistsR :: Name Owner -> Maybe Count -> Request k (Vector Gist)

List gists. See https://developer.github.com/v3/gists/#list-gists

gistR :: Name Gist -> Request k Gist

Query a single gist. See https://developer.github.com/v3/gists/#get-a-single-gist

Comments

See https://developer.github.com/v3/gists/comments/

Missing endpoints: * Create a comment * Edit a comment * Delete a comment

commentsOnR :: Name Gist -> Maybe Count -> Request k (Vector GistComment)

List comments on a gist. See https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist

gistCommentR :: Id GistComment -> Request k GistComment

Query a single comment. See https://developer.github.com/v3/gists/comments/#get-a-single-comment

Git Data

See https://developer.github.com/v3/git/

Blobs

See https://developer.github.com/v3/git/blobs/

blobR :: Name Owner -> Name Repo -> Name Blob -> Request k Blob

Query a blob. See https://developer.github.com/v3/git/blobs/#get-a-blob

Commits

See https://developer.github.com/v3/git/commits/

gitCommitR :: Name Owner -> Name Repo -> Name GitCommit -> Request k GitCommit

Query a commit. See https://developer.github.com/v3/git/commits/#get-a-commit

References

See https://developer.github.com/v3/git/refs/

referenceR :: Name Owner -> Name Repo -> Name GitReference -> Request k GitReference

Query a reference. See https://developer.github.com/v3/git/refs/#get-a-reference

referencesR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector GitReference)

Query all References. See https://developer.github.com/v3/git/refs/#get-all-references

createReferenceR :: Name Owner -> Name Repo -> NewGitReference -> Request True GitReference

Create a reference. See https://developer.github.com/v3/git/refs/#create-a-reference

Trees

See https://developer.github.com/v3/git/trees/

treeR :: Name Owner -> Name Repo -> Name Tree -> Request k Tree

Query a Tree. See https://developer.github.com/v3/git/trees/#get-a-tree

nestedTreeR :: Name Owner -> Name Repo -> Name Tree -> Request k Tree

Query a Tree Recursively. See https://developer.github.com/v3/git/trees/#get-a-tree-recursively

Issues

See https://developer.github.com/v3/issues/

Missing endpoints:

• List issues

issueR :: Name Owner -> Name Repo -> Id Issue -> Request k Issue

Query a single issue. See https://developer.github.com/v3/issues/#get-a-single-issue

issuesForRepoR :: Name Owner -> Name Repo -> [IssueLimitation] -> Maybe Count -> Request k (Vector Issue)

List issues for a repository. See https://developer.github.com/v3/issues/#list-issues-for-a-repository

createIssueR :: Name Owner -> Name Repo -> NewIssue -> Request True Issue

Create an issue. See https://developer.github.com/v3/issues/#create-an-issue

editIssueR :: Name Owner -> Name Repo -> Id Issue -> EditIssue -> Request True Issue

Edit an issue. See https://developer.github.com/v3/issues/#edit-an-issue

Comments

See https://developer.github.com/v3/issues/comments/

Missing endpoints:

• Delete comment

commentR :: Name Owner -> Name Repo -> Id Comment -> Request k IssueComment

Query a single comment. See https://developer.github.com/v3/issues/comments/#get-a-single-comment

commentsR :: Name Owner -> Name Repo -> Id Issue -> Maybe Count -> Request k (Vector IssueComment)

List comments on an issue. See https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

createCommentR :: Name Owner -> Name Repo -> Id Issue -> Text -> Request True Comment

Create a comment. See https://developer.github.com/v3/issues/comments/#create-a-comment

editCommentR :: Name Owner -> Name Repo -> Id Comment -> Text -> Request True Comment

Edit a comment. See https://developer.github.com/v3/issues/comments/#edit-a-comment

Events

See https://developer.github.com/v3/issues/events/

eventsForIssueR :: Name Owner -> Name Repo -> Id Issue -> Maybe Count -> Request k (Vector Event)

List events for an issue. See https://developer.github.com/v3/issues/events/#list-events-for-an-issue

eventsForRepoR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Event)

List events for a repository. See https://developer.github.com/v3/issues/events/#list-events-for-a-repository

eventR :: Name Owner -> Name Repo -> Id Event -> Request k Event

Query a single event. See https://developer.github.com/v3/issues/events/#get-a-single-event

Labels

See https://developer.github.com/v3/issues/labels/

labelsOnRepoR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector IssueLabel)

List all labels for this repository. See https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository

labelR :: Name Owner -> Name Repo -> Name IssueLabel -> Request k IssueLabel

Query a single label. See https://developer.github.com/v3/issues/labels/#get-a-single-label

createLabelR :: Name Owner -> Name Repo -> Name IssueLabel -> String -> Request True IssueLabel

Create a label. See https://developer.github.com/v3/issues/labels/#create-a-label

updateLabelR

Arguments

:: Name Owner

-> Name Repo

-> Name IssueLabel

old label name

-> Name IssueLabel

new label name

-> String

new color

-> Request True IssueLabel

Update a label. See https://developer.github.com/v3/issues/labels/#update-a-label

deleteLabelR :: Name Owner -> Name Repo -> Name IssueLabel -> Request True ()

Delete a label. See https://developer.github.com/v3/issues/labels/#delete-a-label

labelsOnIssueR :: Name Owner -> Name Repo -> Id Issue -> Maybe Count -> Request k (Vector IssueLabel)

List labels on an issue. See https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue

addLabelsToIssueR :: Foldable f => Name Owner -> Name Repo -> Id Issue -> f (Name IssueLabel) -> Request True (Vector IssueLabel)

Add lables to an issue. See https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue

removeLabelFromIssueR :: Name Owner -> Name Repo -> Id Issue -> Name IssueLabel -> Request True ()

Remove a label from an issue. See https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue

replaceAllLabelsForIssueR :: Foldable f => Name Owner -> Name Repo -> Id Issue -> f (Name IssueLabel) -> Request True (Vector IssueLabel)

Replace all labels on an issue. See https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue

Sending an empty list will remove all labels from the issue.

removeAllLabelsFromIssueR :: Name Owner -> Name Repo -> Id Issue -> Request True ()

Remove all labels from an issue. See https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue

labelsOnMilestoneR :: Name Owner -> Name Repo -> Id Milestone -> Maybe Count -> Request k (Vector IssueLabel)

Query labels for every issue in a milestone. See https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone

Milestone

See https://developer.github.com/v3/issues/milestones/

Missing endpoints:

• Create a milestone
• Update a milestone
• Delete a milestone

milestonesR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Milestone)

List milestones for a repository. See https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository

milestoneR :: Name Owner -> Name Repo -> Id Milestone -> Request k Milestone

Query a single milestone. See https://developer.github.com/v3/issues/milestones/#get-a-single-milestone

Organizations

See https://developer.github.com/v3/orgs/

Missing endpoints:

• List your organizations
• List all organizations
• Edit an organization

publicOrganizationsForR :: Name User -> Maybe Count -> Request k (Vector SimpleOrganization)

List user organizations. See https://developer.github.com/v3/orgs/#list-user-organizations

publicOrganizationR :: Name Organization -> Request k Organization

Query an organization. See https://developer.github.com/v3/orgs/#get-an-organization

Members

See https://developer.github.com/v3/orgs/members/

Missing endpoints: All except Members List

membersOfR :: Name Organization -> Maybe Count -> Request k (Vector SimpleUser)

All the users who are members of the specified organization.

See https://developer.github.com/v3/orgs/members/#members-list

membersOfWithR :: Name Organization -> OrgMemberFilter -> OrgMemberRole -> Maybe Count -> Request k (Vector SimpleUser)

membersOfR with filters.

See https://developer.github.com/v3/orgs/members/#members-list

Teams

See https://developer.github.com/v3/orgs/teams/

Missing endpoints:

• Query team member (deprecated)
• Add team member (deprecated)
• Remove team member (deprecated)
• List team repos
• Check if a team manages a repository
• Add team repository
• Remove team repository

teamsOfR :: Name Organization -> Maybe Count -> Request k (Vector SimpleTeam)

List teams. See https://developer.github.com/v3/orgs/teams/#list-teams

teamInfoForR :: Id Team -> Request k Team

Query team. See https://developer.github.com/v3/orgs/teams/#get-team

createTeamForR :: Name Organization -> CreateTeam -> Request True Team

Create team. See https://developer.github.com/v3/orgs/teams/#create-team

editTeamR :: Id Team -> EditTeam -> Request True Team

Edit team. See https://developer.github.com/v3/orgs/teams/#edit-team

deleteTeamR :: Id Team -> Request True ()

Delete team.

See https://developer.github.com/v3/orgs/teams/#delete-team

listTeamMembersR :: Id Team -> TeamMemberRole -> Maybe Count -> Request True (Vector SimpleUser)

teamMembershipInfoForR :: Id Team -> Name Owner -> Request k TeamMembership

Query team membership. See <https://developer.github.com/v3/orgs/teams/#get-team-membership

addTeamMembershipForR :: Id Team -> Name Owner -> Role -> Request True TeamMembership

Add team membership. See https://developer.github.com/v3/orgs/teams/#add-team-membership

deleteTeamMembershipForR :: Id Team -> Name Owner -> Request True ()

Remove team membership. See https://developer.github.com/v3/orgs/teams/#remove-team-membership

listTeamsCurrentR :: Maybe Count -> Request True (Vector Team)

List user teams. See https://developer.github.com/v3/orgs/teams/#list-user-teams

Pull Requests

See https://developer.github.com/v3/pulls/

pullRequestsForR

Arguments

:: Name Owner

-> Name Repo

-> Maybe String

State

-> Maybe Count

-> Request k (Vector SimplePullRequest)

List pull requests. See https://developer.github.com/v3/pulls/#list-pull-requests

pullRequestR :: Name Owner -> Name Repo -> Id PullRequest -> Request k PullRequest

Query a single pull request. See https://developer.github.com/v3/pulls/#get-a-single-pull-request

createPullRequestR :: Name Owner -> Name Repo -> CreatePullRequest -> Request True PullRequest

Create a pull request. See https://developer.github.com/v3/pulls/#create-a-pull-request

updatePullRequestR :: Name Owner -> Name Repo -> Id PullRequest -> EditPullRequest -> Request True PullRequest

Update a pull request. See https://developer.github.com/v3/pulls/#update-a-pull-request

pullRequestCommitsR :: Name Owner -> Name Repo -> Id PullRequest -> Maybe Count -> Request k (Vector Commit)

List commits on a pull request. See https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request

pullRequestFilesR :: Name Owner -> Name Repo -> Id PullRequest -> Maybe Count -> Request k (Vector File)

List pull requests files. See https://developer.github.com/v3/pulls/#list-pull-requests-files

isPullRequestMergedR :: Name Owner -> Name Repo -> Id PullRequest -> Request k Bool

Query if a pull request has been merged. See https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

mergePullRequestR :: Name Owner -> Name Repo -> Id PullRequest -> Maybe String -> Request True MergeResult

Merge a pull request (Merge Button). https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button

Review comments

See https://developer.github.com/v3/pulls/comments/

Missing endpoints:

• List comments in a repository
• Create a comment
• Edit a comment
• Delete a comment

pullRequestReviewCommentsR :: Name Owner -> Name Repo -> Id PullRequest -> Maybe Count -> Request k (Vector Comment)

List comments on a pull request. See https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request

pullRequestReviewCommentR :: Name Owner -> Name Repo -> Id Comment -> Request k Comment

Query a single comment. See https://developer.github.com/v3/pulls/comments/#get-a-single-comment

Repositories

See https://developer.github.com/v3/repos/

Missing endpoints:

• List all public repositories
• List Teams
• Query Branch
• Enabling and disabling branch protection

currentUserReposR :: RepoPublicity -> Maybe Count -> Request k (Vector Repo)

List your repositories. See https://developer.github.com/v3/repos/#list-your-repositories

userReposR :: Name Owner -> RepoPublicity -> Maybe Count -> Request k (Vector Repo)

List user repositories. See https://developer.github.com/v3/repos/#list-user-repositories

organizationReposR :: Name Organization -> RepoPublicity -> Maybe Count -> Request k (Vector Repo)

List organization repositories. See https://developer.github.com/v3/repos/#list-organization-repositories

repositoryR :: Name Owner -> Name Repo -> Request k Repo

Query single repository. See https://developer.github.com/v3/repos/#get

contributorsR

Arguments

:: Name Owner

-> Name Repo

-> Bool

Include anonymous

-> Maybe Count

-> Request k (Vector Contributor)

List contributors. See https://developer.github.com/v3/repos/#list-contributors

languagesForR :: Name Owner -> Name Repo -> Request k Languages

List languages. See https://developer.github.com/v3/repos/#list-languages

tagsForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Tag)

List tags. See https://developer.github.com/v3/repos/#list-tags

branchesForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Branch)

List branches. See https://developer.github.com/v3/repos/#list-branches

Collaborators

See https://developer.github.com/v3/repos/collaborators/

collaboratorsOnR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector SimpleUser)

List collaborators. See https://developer.github.com/v3/repos/collaborators/#list-collaborators

isCollaboratorOnR

Arguments

:: Name Owner

Repository owner

-> Name Repo

Repository name

-> Name User

Collaborator?

-> Request k Bool

Check if a user is a collaborator. See https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator

Comments

See https://developer.github.com/v3/repos/comments/

Missing endpoints:

• Create a commit comment
• Update a commit comment
• Delete a commit comment

commentsForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Comment)

List commit comments for a repository. See https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository

commitCommentsForR :: Name Owner -> Name Repo -> Name Commit -> Maybe Count -> Request k (Vector Comment)

List comments for a single commit. See https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit

commitCommentForR :: Name Owner -> Name Repo -> Id Comment -> Request k Comment

Query a single commit comment. See https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment

Commits

See https://developer.github.com/v3/repos/commits/

commitsForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Commit)

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commitsWithOptionsForR :: Name Owner -> Name Repo -> Maybe Count -> [CommitQueryOption] -> Request k (Vector Commit)

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commitR :: Name Owner -> Name Repo -> Name Commit -> Request k Commit

Query a single commit. See https://developer.github.com/v3/repos/commits/#get-a-single-commit

diffR :: Name Owner -> Name Repo -> Name Commit -> Name Commit -> Request k Diff

Compare two commits. See https://developer.github.com/v3/repos/commits/#compare-two-commits

Forks

See https://developer.github.com/v3/repos/forks/

Missing endpoints:

• Create a fork

forksForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Repo)

List forks. See https://developer.github.com/v3/repos/forks/#list-forks

Webhooks

See https://developer.github.com/v3/repos/hooks/

webhooksForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector RepoWebhook)

List hooks. See https://developer.github.com/v3/repos/hooks/#list-hooks

webhookForR :: Name Owner -> Name Repo -> Id RepoWebhook -> Request k RepoWebhook

Query single hook. See https://developer.github.com/v3/repos/hooks/#get-single-hook

createRepoWebhookR :: Name Owner -> Name Repo -> NewRepoWebhook -> Request True RepoWebhook

Create a hook. See https://developer.github.com/v3/repos/hooks/#create-a-hook

editRepoWebhookR :: Name Owner -> Name Repo -> Id RepoWebhook -> EditRepoWebhook -> Request True RepoWebhook

Edit a hook. See https://developer.github.com/v3/repos/hooks/#edit-a-hook

testPushRepoWebhookR :: Name Owner -> Name Repo -> Id RepoWebhook -> Request True Bool

Test a push hook. See https://developer.github.com/v3/repos/hooks/#test-a-push-hook

pingRepoWebhookR :: Name Owner -> Name Repo -> Id RepoWebhook -> Request True Bool

Ping a hook. See https://developer.github.com/v3/repos/hooks/#ping-a-hook

deleteRepoWebhookR :: Name Owner -> Name Repo -> Id RepoWebhook -> Request True ()

Delete a hook. See https://developer.github.com/v3/repos/hooks/#delete-a-hook

Search

See https://developer.github.com/v3/search/

Missing endpoints:

• Search users

searchReposR :: Text -> Request k (SearchResult Repo)

Search repositories. See https://developer.github.com/v3/search/#search-repositories

searchCodeR :: Text -> Request k (SearchResult Code)

Search code. See https://developer.github.com/v3/search/#search-code

searchIssuesR :: Text -> Request k (SearchResult Issue)

Search issues. See https://developer.github.com/v3/search/#search-issues

Users

See https://developer.github.com/v3/users/

Missing endpoints:

• Update the authenticated user
• Query all users

userInfoForR :: Name User -> Request k User

Query a single user. See https://developer.github.com/v3/users/#get-a-single-user

ownerInfoForR :: Name Owner -> Request k Owner

Query a single user or an organization. See https://developer.github.com/v3/users/#get-a-single-user

userInfoCurrentR :: Request True User

Query the authenticated user. See https://developer.github.com/v3/users/#get-the-authenticated-user

Followers

See https://developer.github.com/v3/users/followers/

Missing endpoints:

• Check if you are following a user
• Check if one user follows another
• Follow a user
• Unfollow a user

usersFollowingR :: Name User -> Maybe Count -> Request k (Vector SimpleUser)

List followers of a user. See https://developer.github.com/v3/users/followers/#list-followers-of-a-user

usersFollowedByR :: Name User -> Maybe Count -> Request k (Vector SimpleUser)

List users followed by another user. See https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user

Data definitions

module GitHub.Data

Request handling

module GitHub.Request