github-0.23: Access to the GitHub API, v3.

LicenseBSD-3-Clause
MaintainerOleg Grenrus <oleg.grenrus@iki.fi>
Safe HaskellNone
LanguageHaskell2010

GitHub

Contents

Description

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.Endpoints.Users) for already composed versions.

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

Synopsis

Activity

Events

Notifications

Starring

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

Missing endpoints:

  • Check if you are starring a repository

Watching

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

Missing endpoints:

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

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
  • Check if a gist is starred
  • Fork a gist
  • List gist forks

Comments

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

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

Git Data

Blobs

Commits

References

Trees

Issues

Comments

Events

Labels

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

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.

Milestone

Organizations

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

Missing endpoints:

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

Members

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

Missing endpoints: All except Members List and Check Membership

membersOfR :: Name Organization -> FetchCount -> Request k (Vector SimpleUser) Source #

All the users who are members of the specified organization.

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)
  • Check if a team manages a repository
  • Add team repository
  • Remove team repository

Pull Requests

Review comments

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

Missing endpoints:

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

Pull request reviews

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

Missing endpoints:

  • Delete a pending review
  • Create a pull request review
  • Submit a pull request review
  • Dismiss a pull request review

pullRequestReviews :: Name Owner -> Name Repo -> Id PullRequest -> IO (Either Error (Vector Review)) Source #

All reviews for a pull request given the repo owner, repo name and the pull request id.

pullRequestReviews "thoughtbot" "paperclip" (Id 101)

pullRequestReviews' :: Maybe Auth -> Name Owner -> Name Repo -> Id PullRequest -> IO (Either Error (Vector Review)) Source #

All reviews for a pull request given the repo owner, repo name and the pull request id. With authentication.

pullRequestReviews' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" (Id 101)

pullRequestReview :: Name Owner -> Name Repo -> Id PullRequest -> Id Review -> IO (Either Error Review) Source #

A detailed review on a pull request given the repo owner, repo name, pull request id and review id.

pullRequestReview "thoughtbot" "factory_girl" (Id 301819) (Id 332)

pullRequestReview' :: Maybe Auth -> Name Owner -> Name Repo -> Id PullRequest -> Id Review -> IO (Either Error Review) Source #

A detailed review on a pull request given the repo owner, repo name, pull request id and review id. With authentication.

pullRequestReview' (Just $ BasicAuth "github-username" "github-password")
"thoughtbot" "factory_girl" (Id 301819) (Id 332)

pullRequestReviewCommentsIO :: Name Owner -> Name Repo -> Id PullRequest -> Id Review -> IO (Either Error [ReviewComment]) Source #

All comments for a review on a pull request given the repo owner, repo name, pull request id and review id.

pullRequestReviewComments "thoughtbot" "factory_girl" (Id 301819) (Id 332)

pullRequestReviewCommentsIO' :: Maybe Auth -> Name Owner -> Name Repo -> Id PullRequest -> Id Review -> IO (Either Error [ReviewComment]) Source #

All comments for a review on a pull request given the repo owner, repo name, pull request id and review id. With authentication.

pullRequestReviewComments' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "factory_girl" (Id 301819) (Id 332)

Repositories

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

Missing endpoints:

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

Collaborators

isCollaboratorOnR Source #

Arguments

:: Name Owner

Repository owner

-> Name Repo

Repository name

-> Name User

Collaborator?

-> GenRequest MtStatus rw Bool 

addCollaboratorR Source #

Arguments

:: Name Owner

Repository owner

-> Name Repo

Repository name

-> Name User

Collaborator to add

-> GenRequest MtJSON RW (Maybe RepoInvitation) 

Comments

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

Missing endpoints:

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

Commits

Deployments

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

Missing endpoints: * Get a single deployment * Update a deployment * Get a single deployment status

Forks

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

Missing endpoints:

  • Create a fork

Webhooks

Releases

Invitations

Delete a repository invitation

Update a repository invitation

Decline a repository invitation

Search

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

Missing endpoints:

  • Search users

Users

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

Missing endpoints:

  • Update the authenticated user
  • Query all users

Emails

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

Missing endpoints:

  • Add email address(es)
  • Delete email address(es)
  • Toggle primary email visibility

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

Statuses

Rate Limit

Data definitions

Request handling