Skip to main content

Module client

Module client 

Source
Expand description

The GitHub API: REST for repositories, issues, gists and the rest, and GraphQL for Projects boards.

Structs§

Conditions
How this side asks for “only what I do not already have”.
CreateCommentRequest
CreateGistRequest
CreateIssueRequest
GistFileInput
GitHubCheckRun
GitHubChecks
What CI says about one commit.
GitHubClient
GitHub REST API client for issues management.
GitHubComment
GitHubGist
GitHubGistFile
GitHubIssue
GitHubLabel
GitHubMilestone
GitHubNotification
One thing GitHub thinks needs this person.
GitHubNotificationRepo
GitHubNotificationSubject
GitHubProject
A project board.
GitHubProjectField
GitHubProjectFieldOption
GitHubProjectItem
One card.
GitHubPull
A pull request. GitHub’s issues endpoint returns these too, which is why they are filtered out of the issue list — a pull request is a different thing to a person looking at either list.
GitHubPullRef
GitHubRateLimit
How much of the API budget is left.
GitHubRelease
GitHubReleaseAsset
GitHubRepository
What GitHub says a repository IS.
GitHubTag
GitHubTagCommit
GitHubTraffic
How much the world looked at a repository.
GitHubTrafficDay
GitHubUser
GitHubViewer
The account a token belongs to, and the organisations it is a member of.
RepositoryRuleset
A repository ruleset, as much of it as anything here reads.
TrafficSeries
GitHub’s own shape for one traffic series, which this folds into GitHubTraffic.
UpdateGistRequest
UpdateIssueRequest

Enums§

Fetched
What a conditional request answered.
GitHubProjectValue
One field’s value on one item. PartialEq without Eq: a number field holds a float, and floats have no total equality. Comparing two values for “did this change” is exactly what PartialEq is for here.
ProjectFieldWrite
A value being written to a field.

Functions§

parse_github_url
Parse a GitHub URL into (owner, repo). Handles: https://github.com/owner/repo[.git] git@github.com:owner/repo[.git] ssh://git@github.com/owner/repo[.git]