The only dependency you need is (check our latest version available at github.jcabi.com):
<depedency> <groupId>com.jcabi</groupId> <artifactId>jcabi-github</artifactId> </dependency>
There are some design conventions in this library, which is important to keep in mind.
Sometimes we use
as an input argument for a method
(for example, in
somewhere else we use
in other case we use just a few plain Java types
and sometimes we combine them
This is not a bug, it's done intentionally.
The logic is simple.
JsonObject is used when Github API is
expecting a JSON object as HTTP request body.
Map is used when Github API expects HTTP query parameters,
and some of them are optional, and there are more than two of them.
In all other situations we're using plain Java types.
- $Id: 1848c8d633c38acfcdc26899c714dbdd931faab4 $
- Yegor Bugayenko (email@example.com)
- See Also:
- project website
Interface Summary Interface Description AssigneesGithub Assignees. BlobGithub Git blob. BlobsGithub Git Data Blobs. BranchGit branch. BranchesGit branches. CollaboratorsGithub repository collaborators. CommentGithub issue comment. CommentsGithub comments. CommitGithub commit. CommitsGithub Git Data Commits. CommitsComparisonCommits comparison. ContentGithub content. ContentsGithub contents. CoordinatesRepository coordinates. DeployKeyGithub deploy key. DeployKeysGithub deploy keys. EventGithub event. FileChangeFile change. ForkGithub fork. ForksGithub forks. GistGithub gist. GistCommentGist comment. GistCommentsGist Comments. GistsGithub gists. GitGithub Git. GithubGithub client, starting point to the entire library. GitHubThreadRepresents a GitHub notifications thread. GitignoresGithub Gitignore. HookGithub hook. HooksGithub hooks. IssueGithub issue. IssueEventsGithub issue events. IssueLabelsGithub labels of an issue. IssuesGithub issues. JsonPatchableJSON patchable. JsonReadableJSON readable. LabelGithub label. LabelsGithub labels. LanguageGithub repository language. LimitGithub Rate Limit API, one resource limit. LimitsGithub Rate Limit API. MarkdownMarkdown API. MilestoneGithub Milestone. MilestonesGithub Milestones. NotificationGithub Notification. NotificationsGithub Notifications API. OrganizationGithub organization. OrganizationsGithub organizations. PublicKeyGithub public key. PublicKeysGithub public keys. PublicMembersPublic members of a GitHub organization. PullGithub pull request. PullCommentGithub pull comment. PullCommentsGithub pull comments. PullRefGitHub pull request ref. PullsGithub pull requests. ReactionReaction for issue / comment. ReferenceGithub Git Data Reference. ReferencesGithub Git Data References. ReleaseGithub release. ReleaseAssetGithub release asset. ReleaseAssetsGithub release assets. ReleasesGithub Releases. RepoGithub repository. RepoCommitGithub repo commit. RepoCommitsCommits of a Github repository. ReposGithub Repo API. RtValuePagination.Mapping<X,P extends javax.json.JsonValue>Mapping from JsonValue successor to the destination type. SearchGithub search. StarsGithub starring API. StatusGitHub commit status. StatusesGithub status. StringEnumAn enum whose values correspond to unique strings. TagGithub Git Data Tag. TagsGithub Git Data Tags. ThreadSubscriptionEncapsulates data from the response for get/set subscription calls to GitHub Notification API. TreeGithub tree. TreesGithub Git Data Trees. UserGithub user. UserEmailsGithub user's emails. UserOrganizationsOrganizations of a Github user. UsersGithub users.
Class Summary Class Description Blob.SmartSmart Blob with extra features. Bulk<T extends JsonReadable>Bulk items, with pre-saved JSON. Comment.SmartSmart comment with additional features. Commit.SmartSmart commit. CommitsComparison.SmartSmart commits comparison with extra features. Content.SmartSmart Content with extra features. Coordinates.SimpleJcabi.http implementation. DeployKey.SmartSmart DeployKey with extra features. Event.SmartSmart event with extra features. FileChange.SmartSmart file change with extra features. Fork.SmartSmart Fork with extra features. FromPropertiesUser agent data read from the jcabigithub.properties file. Gist.SmartSmart Gist with extra features. GistComment.SmartSmart comment with additional features. Github.TimeTime in Github JSON. Hook.SmartSmart Hook with extra features. Issue.SmartSmart Issue with extra features. IssueLabels.SmartSmart IssueLabels with extra features. Label.SmartSmart Label with extra features. Label.UnmodifiedUnmodified Label with extra features. Labels.SmartSmart Labels with extra features. Limit.SmartSmart limits with extra features. Limit.ThrottledThrottled Limit. Limits.ThrottledThrottled Limits. Milestone.SmartSmart Milestone with extra features. Organization.SmartSmart Organization with extra features. PublicKey.SmartSmart PublicKey with extra features. Pull.SmartSmart pull request with extra features. PullComment.SmartSmart PullComment with extra features. PullRef.SmartSmart pull request ref with extra features. Reaction.SimpleSimple reaction. Release.SmartSmart release. ReleaseAsset.SmartSmart ReleaseAsset with extra features. Releases.SmartSmart releases. Repo.SmartSmart Repo with extra features. RepoCommit.SmartSmart commit. Repos.RepoCreateSettings to use when creating a new GitHub repository. RtBranchGit branch implementation. RtCommitsGithub Commits. RtGithubGithub client, starting point to the entire library. RtLanguageGithub repository language. RtPagination<T>Github pagination. RtPublicMembersPublic members of a GitHub organization. RtReactionRuntime Reaction. RtStatusGithub commit status. RtStatusesGithub statuses for a given commit. RtValuePagination<T,P extends javax.json.JsonValue>Github value pagination. Smarts<T>Smart items. Status.SmartSmart Status with extra features. Statuses.StatusCreateData to use when creating a new GitHub commit status. User.SmartSmart user with extra features.
Enum Summary Enum Description Collaborators.PermissionPermission levels a user can be granted in an organization repository. FileChange.Status Issues.Qualifier Issues.Sort MergeState Search.Order Search.Qualifier Status.StateStates of Status API.