Package com.jcabi.github
The only dependency you need is (check our latest version available at github.jcabi.com):
<dependency> <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 javax.json.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 javax.json.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
- See Also:
-
ClassDescriptionGitHub Assignees.GitHub Git blob.Smart Blob with extra features.GitHub Git Data Blobs.Git branch.Git branches.Bulk<T extends JsonReadable>Bulk items, with pre-saved JSON.GitHub check.Check conclusion.Check status.GitHub checks.GitHub repository collaborators.Permission levels a user can be granted in an organization repository.GitHub issue comment.Smart comment with additional features.GitHub comments.GitHub commit.Smart commit.GitHub Git Data Commits.Commits comparison.Smart commits comparison with extra features.GitHub content.Smart Content with extra features.GitHub contents.Repository coordinates.Implementation of HTTPs coordinates.Jcabi.http implementation.GitHub deploy key.Smart DeployKey with extra features.GitHub deploy keys.GitHub event.Smart event with extra features.File change.Smart file change with extra features.GitHub fork.Smart Fork with extra features.GitHub forks.User agent data read from the jcabigithub.properties file.GitHub gist.Smart Gist with extra features.Gist comment.Smart comment with additional features.Gist Comments.GitHub gists.GitHub Git.GitHub client, starting point to the entire library.Time in GitHub JSON.Represents a GitHub notifications thread.GitHub Gitignore.GitHub hook.Smart Hook with extra features.GitHub hooks.GitHub issue.Smart Issue with extra features.GitHub issue events.GitHub labels of an issue.Smart IssueLabels with extra features.GitHub issues.JSON patchable.JSON readable.GitHub label.Smart Label with extra features.Unmodified Label with extra features.GitHub labels.Smart Labels with extra features.GitHub repository language.GitHub Rate Limit API, one resource limit.Smart limits with extra features.Throttled Limit.GitHub Rate Limit API.Throttled Limits.Markdown API.GitHub Milestone.Smart Milestone with extra features.GitHub Milestones.GitHub Notification.GitHub Notifications API.GitHub organization.Smart Organization with extra features.GitHub organizations.GitHub public key.Smart PublicKey with extra features.GitHub public keys.Public members of a GitHub organization.GitHub pull request.Smart pull request with extra features.GitHub pull comment.Smart PullComment with extra features.GitHub pull comments.GitHub pull request ref.Smart pull request ref with extra features.GitHub pull requests.Reaction for issue / comment.Simple reaction.GitHub Git Data Reference.GitHub Git Data References.GitHub release.Smart release.GitHub release asset.Smart ReleaseAsset with extra features.GitHub release assets.GitHub Releases.Smart releases.GitHub repository.Smart Repo with extra features.GitHub repo commit.Smart commit.Commits of a GitHub repository.GitHub Repo API.Settings to use when creating a new GitHub repository.Repository statistics.Smart RepositoryStatistics.Git branch implementation.GitHub Commits.GitHub client, starting point to the entire library.GitHub repository language.RtPagination<T>GitHub pagination.Public members of a GitHub organization.Runtime Reaction.GitHub stargazers.GitHub commit status.GitHub statuses for a given commit.RtValuePagination<T,
P extends jakarta.json.JsonValue> GitHub value pagination.RtValuePagination.Mapping<X,P extends jakarta.json.JsonValue> Mapping from JsonValue successor to the destination type.GitHub search.Smarts<T>Smart items.List of stargazers.GitHub starring API.GitHub commit status.Smart Status with extra features.States of Status API.GitHub status.Data to use when creating a new GitHub commit status.An enum whose values correspond to unique strings.GitHub Git Data Tag.GitHub Git Data Tags.Encapsulates data from the response for get/set subscription calls to GitHub Notification API.GitHub tree.GitHub Git Data Trees.GitHub user.Smart user with extra features.GitHub user's emails.Organizations of a GitHub user.GitHub users.