github-0.29: Access to the GitHub API, v3.
Safe HaskellSafe-Inferred
LanguageHaskell2010

GitHub

Description

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

See GitHub.Request module for executing Request, in short use github request, for example

github userInfoForR
  :: AuthMethod am => am -> Name User -> IO (Either Error User)

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

Gists

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

Missing endpoints:

  • Query a specific revision of 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

Outside Collaborators

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

Missing endpoints: All except Outside Collaborator 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

Repositories

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

Missing endpoints:

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

Collaborators

collaboratorPermissionOnR Source #

Arguments

:: Name Owner

Repository owner

-> Name Repo

Repository name

-> Name User

Collaborator to check permissions of.

-> GenRequest 'MtJSON rw CollaboratorWithPermission 

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

Contents

contentsForR Source #

Arguments

:: Name Owner 
-> Name Repo 
-> Text

file or directory

-> Maybe Text

Git commit

-> Request k Content 

archiveForR Source #

Arguments

:: Name Owner 
-> Name Repo 
-> ArchiveFormat

The type of archive to retrieve

-> Maybe Text

Git commit

-> GenRequest 'MtRedirect rw URI 

Deploy Keys

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

Statuses

Webhooks

Releases

Invitations

Delete a repository invitation

Update a repository invitation

Decline a repository invitation

Search

Users

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

Missing endpoints:

  • Update the authenticated user
  • Query all users

userInfoForR :: Name User -> Request k User Source #

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

>>> github' userInfoForR "mike-burns"

or

>>> github userInfoForR (OAuth "github-token") "mike-burns"

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

Git SSH Keys

Rate Limit

Actions - artifacts

Actions - cache

Actions - secrets

Actions - workflow jobs

Actions - workflow runs

Actions - workflows

Data definitions

Request handling