Package com.jcabi.github
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 JsonObject
as an input argument for a method
(for example, in Repos
),
somewhere else we use Map
(see Issues.iterate(Map)
),
in other case we use just a few plain Java types
(see DeployKeys.create(String,String)
),
and sometimes we combine them
(see Hooks
).
This is not a bug, it's done intentionally.
The logic is simple.
Class 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.
- Since:
- 0.1
- Version:
- $Id: 1848c8d633c38acfcdc26899c714dbdd931faab4 $
- Author:
- Yegor Bugayenko (yegor256@gmail.com)
- See Also:
- project website
-
Interface Summary Interface Description Assignees Github Assignees.Blob Github Git blob.Blobs Github Git Data Blobs.Branch Git branch.Branches Git branches.Collaborators Github repository collaborators.Comment Github issue comment.Comments Github comments.Commit Github commit.Commits Github Git Data Commits.CommitsComparison Commits comparison.Content Github content.Contents Github contents.Coordinates Repository coordinates.DeployKey Github deploy key.DeployKeys Github deploy keys.Event Github event.FileChange File change.Fork Github fork.Forks Github forks.Gist Github gist.GistComment Gist comment.GistComments Gist Comments.Gists Github gists.Git Github Git.Github Github client, starting point to the entire library.GitHubThread Represents a GitHub notifications thread.Gitignores Github Gitignore.Hook Github hook.Hooks Github hooks.Issue Github issue.IssueEvents Github issue events.IssueLabels Github labels of an issue.Issues Github issues.JsonPatchable JSON patchable.JsonReadable JSON readable.Label Github label.Labels Github labels.Language Github repository language.Limit Github Rate Limit API, one resource limit.Limits Github Rate Limit API.Markdown Markdown API.Milestone Github Milestone.Milestones Github Milestones.Notification Github Notification.Notifications Github Notifications API.Organization Github organization.Organizations Github organizations.PublicKey Github public key.PublicKeys Github public keys.PublicMembers Public members of a GitHub organization.Pull Github pull request.PullComment Github pull comment.PullComments Github pull comments.PullRef GitHub pull request ref.Pulls Github pull requests.Reaction Reaction for issue / comment.Reference Github Git Data Reference.References Github Git Data References.Release Github release.ReleaseAsset Github release asset.ReleaseAssets Github release assets.Releases Github Releases.Repo Github repository.RepoCommit Github repo commit.RepoCommits Commits of a Github repository.Repos Github Repo API.RtValuePagination.Mapping<X,P extends javax.json.JsonValue> Mapping from JsonValue successor to the destination type.Search Github search.Stars Github starring API.Status GitHub commit status.Statuses Github status.StringEnum An enum whose values correspond to unique strings.Tag Github Git Data Tag.Tags Github Git Data Tags.ThreadSubscription Encapsulates data from the response for get/set subscription calls to GitHub Notification API.Tree Github tree.Trees Github Git Data Trees.User Github user.UserEmails Github user's emails.UserOrganizations Organizations of a Github user.Users Github users. -
Class Summary Class Description Blob.Smart Smart Blob with extra features.Bulk<T extends JsonReadable> Bulk items, with pre-saved JSON.Comment.Smart Smart comment with additional features.Commit.Smart Smart commit.CommitsComparison.Smart Smart commits comparison with extra features.Content.Smart Smart Content with extra features.Coordinates.Simple Jcabi.http implementation.DeployKey.Smart Smart DeployKey with extra features.Event.Smart Smart event with extra features.FileChange.Smart Smart file change with extra features.Fork.Smart Smart Fork with extra features.FromProperties User agent data read from the jcabigithub.properties file.Gist.Smart Smart Gist with extra features.GistComment.Smart Smart comment with additional features.Github.Time Time in Github JSON.Hook.Smart Smart Hook with extra features.Issue.Smart Smart Issue with extra features.IssueLabels.Smart Smart IssueLabels with extra features.Label.Smart Smart Label with extra features.Label.Unmodified Unmodified Label with extra features.Labels.Smart Smart Labels with extra features.Limit.Smart Smart limits with extra features.Limit.Throttled Throttled Limit.Limits.Throttled Throttled Limits.Milestone.Smart Smart Milestone with extra features.Organization.Smart Smart Organization with extra features.PublicKey.Smart Smart PublicKey with extra features.Pull.Smart Smart pull request with extra features.PullComment.Smart Smart PullComment with extra features.PullRef.Smart Smart pull request ref with extra features.Reaction.Simple Simple reaction.Release.Smart Smart release.ReleaseAsset.Smart Smart ReleaseAsset with extra features.Releases.Smart Smart releases.Repo.Smart Smart Repo with extra features.RepoCommit.Smart Smart commit.Repos.RepoCreate Settings to use when creating a new GitHub repository.RtBranch Git branch implementation.RtCommits Github Commits.RtGithub Github client, starting point to the entire library.RtLanguage Github repository language.RtPagination<T> Github pagination.RtPublicMembers Public members of a GitHub organization.RtReaction Runtime Reaction.RtStatus Github commit status.RtStatuses Github statuses for a given commit.RtValuePagination<T,P extends javax.json.JsonValue> Github value pagination.Smarts<T> Smart items.Status.Smart Smart Status with extra features.Statuses.StatusCreate Data to use when creating a new GitHub commit status.User.Smart Smart user with extra features. -
Enum Summary Enum Description Collaborators.Permission Permission levels a user can be granted in an organization repository.FileChange.Status Issues.Qualifier Issues.Sort MergeState Search.Order Search.Qualifier Status.State States of Status API.