Package de.carne.gradle.plugin.java.util

Interface GitHubApi

public interface GitHubApi

GitHub API interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GitHubApi.CreateOrEditReleaseRequest	See https://developer.github.com/v3/repos/releases/
static class	GitHubApi.ReleaseAssetInfo	See https://developer.github.com/v3/repos/releases/
static class	GitHubApi.ReleaseInfo	See https://developer.github.com/v3/repos/releases/
static class	GitHubApi.ReleaseUserInfo	See https://developer.github.com/v3/repos/releases/
static class	GitHubApi.ResponseStatus	See https://developer.github.com/v3/

Method Summary

Modifier and Type	Method	Description
GitHubApi.ReleaseInfo	createRelease(java.lang.String owner, java.lang.String repo, GitHubApi.CreateOrEditReleaseRequest request)	Creates a release.
void	deleteRelease(java.lang.String owner, java.lang.String repo, java.lang.String releaseId)	Deletes a release.
GitHubApi.ReleaseInfo	getRelease(java.lang.String owner, java.lang.String repo, java.lang.String releaseId)	Gets a release.
java.util.List<GitHubApi.ReleaseInfo>	listReleases(java.lang.String owner, java.lang.String repo, int page)	Lists all releases.

Method Detail

listReleases

@GET
@Path("/repos/{owner}/{repo}/releases")
@Produces("application/json")
java.util.List<GitHubApi.ReleaseInfo> listReleases(@PathParam("owner")
                                                   java.lang.String owner,
                                                   @PathParam("repo")
                                                   java.lang.String repo,
                                                   @QueryParam("page")
                                                   int page)

Lists all releases.

Parameters:

owner - the owner of the release to get.

repo - the repository of the release to get.

page - the result page to get.

Returns:

the retrieved release.

getRelease

@GET
@Path("/repos/{owner}/{repo}/releases/{releaseId}")
@Produces("application/json")
GitHubApi.ReleaseInfo getRelease(@PathParam("owner")
                                 java.lang.String owner,
                                 @PathParam("repo")
                                 java.lang.String repo,
                                 @PathParam("releaseId")
                                 java.lang.String releaseId)

Gets a release.

Parameters:

owner - the owner of the release to get.

repo - the repository of the release to get.

releaseId - the id of the release to get.

Returns:

the retrieved release.

deleteRelease

@DELETE
@Path("/repos/{owner}/{repo}/releases/{releaseId}")
void deleteRelease(@PathParam("owner")
                   java.lang.String owner,
                   @PathParam("repo")
                   java.lang.String repo,
                   @PathParam("releaseId")
                   java.lang.String releaseId)

Deletes a release.

Parameters:

owner - the owner of the release to delete.

repo - the repository of the release to delete.

releaseId - the id of the release to delete.

createRelease

@POST
@Path("/repos/{owner}/{repo}/releases")
@Consumes("application/json")
@Produces("application/json")
GitHubApi.ReleaseInfo createRelease(@PathParam("owner")
                                    java.lang.String owner,
                                    @PathParam("repo")
                                    java.lang.String repo,
                                    GitHubApi.CreateOrEditReleaseRequest request)

Creates a release.

Parameters:

owner - the owner of the release to delete.

repo - the repository of the release to delete.

request - the create request object.

Returns:

the created release.