io.micronaut.starter.client.github.v3

Interface GitHubApiOperations

All Known Subinterfaces:

GitHubApiClient

public interface GitHubApiOperations

GitHub Oauth operations.

Since:

2.2

Author:

Pavol Gressa

Method Summary

Modifier and Type	Method and Description
GitHubRepository	createRepository(java.lang.String oauthToken, GitHubRepository gitHubRepository)
void	createSecret(java.lang.String oauthToken, java.lang.String owner, java.lang.String repo, java.lang.String secretName, GitHubSecret secret)
void	deleteRepository(java.lang.String oauthToken, java.lang.String owner, java.lang.String repo)
GitHubRepository	getRepository(java.lang.String oauthToken, java.lang.String owner, java.lang.String repo)
GitHubSecretsPublicKey	getSecretPublicKey(java.lang.String oauthToken, java.lang.String owner, java.lang.String repo)
GitHubUser	getUser(java.lang.String oauthToken)
GitHubWorkflowRun	getWorkflowRun(java.lang.String oauthToken, java.lang.String owner, java.lang.String repo, java.lang.Long runId)
GitHubWorkflowRuns	listWorkflows(java.lang.String oauthToken, java.lang.String owner, java.lang.String repo)

Method Detail

createRepository

@Post(value="/user/repos",
      single=true)
GitHubRepository createRepository(@Header(value="Authorization")
                                                                                java.lang.String oauthToken,
                                                                                @Body
                                                                                GitHubRepository gitHubRepository)

getRepository

@Get(value="/repos/{owner}/{repo}",
     single=true)
GitHubRepository getRepository(@Header(value="Authorization")
                                                                                     java.lang.String oauthToken,
                                                                                     @PathVariable
                                                                                     java.lang.String owner,
                                                                                     @PathVariable
                                                                                     java.lang.String repo)

deleteRepository

@Delete(value="/repos/{owner}/{repo}")
void deleteRepository(@Header(value="Authorization")
                                                             java.lang.String oauthToken,
                                                             @PathVariable
                                                             java.lang.String owner,
                                                             @PathVariable
                                                             java.lang.String repo)

getUser

@Get(value="/user",
     single=true)
GitHubUser getUser(@Header(value="Authorization")
                                                         java.lang.String oauthToken)

createSecret

@Put(value="/repos/{owner}/{repo}/actions/secrets/{secretName}")
void createSecret(@Header(value="Authorization")
                                                                                   java.lang.String oauthToken,
                                                                                   @PathVariable
                                                                                   java.lang.String owner,
                                                                                   @PathVariable
                                                                                   java.lang.String repo,
                                                                                   @PathVariable
                                                                                   java.lang.String secretName,
                                                                                   @Body
                                                                                   GitHubSecret secret)

getSecretPublicKey

@Get(value="/repos/{owner}/{repo}/actions/secrets/public-key")
GitHubSecretsPublicKey getSecretPublicKey(@Header(value="Authorization")
                                                                                                         java.lang.String oauthToken,
                                                                                                         @PathVariable
                                                                                                         java.lang.String owner,
                                                                                                         @PathVariable
                                                                                                         java.lang.String repo)

listWorkflows

@Get(value="/repos/{owner}/{repo}/actions/runs")
GitHubWorkflowRuns listWorkflows(@Header(value="Authorization")
                                                                                  java.lang.String oauthToken,
                                                                                  @PathVariable
                                                                                  java.lang.String owner,
                                                                                  @PathVariable
                                                                                  java.lang.String repo)

getWorkflowRun

@Get(value="/repos/{owner}/{repo}/actions/runs/{runId}")
GitHubWorkflowRun getWorkflowRun(@Header(value="Authorization")
                                                                                          java.lang.String oauthToken,
                                                                                          @PathVariable
                                                                                          java.lang.String owner,
                                                                                          @PathVariable
                                                                                          java.lang.String repo,
                                                                                          @PathVariable
                                                                                          java.lang.Long runId)