Package

A Pony library for interacting with the GitHub REST API.

Start by creating a GitHub instance with your credentials, then use its methods to fetch repositories, issues, gists, and other resources. All API operations return Promise-based results as (Model | RequestError) unions.

use "github_rest_api"
use "github_rest_api/request"

let creds = Credentials(auth, "your-token-here")
let github = GitHub(creds)
github.get_repo("ponylang", "ponyc")

Returned model objects provide convenience methods for related API calls — for example, a Repository can create labels and releases, and an Issue can create comments.

Public Types

• class Asset
• primitive AssetJsonConverter
• primitive CheckGistStar
• class Commit
• class CommitFile
• primitive CommitFileJsonConverter
• primitive CommitJsonConverter
• type CommitOrError
• primitive CreateGist
• primitive CreateGistComment
• primitive CreateIssueComment
• primitive CreateLabel
• primitive CreateRelease
• primitive DeleteGist
• primitive DeleteGistComment
• primitive DeleteLabel
• primitive ForkGist
• primitive GetCommit
• primitive GetGist
• primitive GetGistComment
• primitive GetGistComments
• primitive GetGistCommits
• primitive GetGistForks
• primitive GetGistRevision
• primitive GetIssue
• primitive GetIssueComments
• primitive GetOrganizationRepositories
• primitive GetPublicGists
• primitive GetPullRequest
• primitive GetPullRequestFiles
• primitive GetRepository
• primitive GetRepositoryIssues
• primitive GetRepositoryLabels
• primitive GetStarredGists
• primitive GetUserGists
• primitive GetUsernameGists
• class Gist
• class GistChangeStatus
• primitive GistChangeStatusJsonConverter
• class GistComment
• primitive GistCommentJsonConverter
• type GistCommentOrError
• class GistCommit
• primitive GistCommitJsonConverter
• class GistFile
• primitive GistFileDelete
• class GistFileEdit
• primitive GistFileJsonConverter
• class GistFileRename
• type GistFileUpdate
• primitive GistJsonConverter
• type GistOrError
• class GitCommit
• primitive GitCommitJsonConverter
• class GitHub
• class GitPerson
• primitive GitPersonJsonConverter
• class Issue
• class IssueComment
• primitive IssueCommentJsonConverter
• type IssueCommentOrError
• type IssueComments
• primitive IssueCommentsJsonConverter
• type IssueCommentsOrError
• primitive IssueCommentsURL
• primitive IssueJsonConverter
• type IssueOrError
• class IssuePullRequest
• primitive IssuePullRequestJsonConverter
• type IssueSearchResultsOrError
• type IssueSort
• primitive JsonNavUtil
• class Label
• primitive LabelJsonConverter
• type LabelOrError
• class License
• primitive LicenseJsonConverter
• actor LinkedJsonRequester
• interface LinkedResultReceiver
• class PaginatedList
• class PaginatedListJsonConverter
• actor PaginatedResultReceiver
• class PaginatedSearchJsonConverter
• class PullRequest
• class PullRequestBase
• primitive PullRequestBaseJsonConverter
• class PullRequestFile
• type PullRequestFiles
• primitive PullRequestFilesJsonConverter
• type PullRequestFilesOrError
• primitive PullRequestJsonConverter
• type PullRequestOrError
• class Release
• primitive ReleaseJsonConverter
• type ReleaseOrError
• class Repository
• primitive RepositoryJsonConverter
• type RepositoryOrError
• primitive SearchIssues
• actor SearchResultReceiver
• class SearchResults
• primitive SortAscending
• primitive SortByComments
• primitive SortByCreated
• primitive SortByUpdated
• primitive SortDescending
• type SortDirection
• primitive StarGist
• primitive UnstarGist
• primitive UpdateGist
• primitive UpdateGistComment
• class User
• primitive UserJsonConverter