Package 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	Description
GitHubRepository	createRepository(String oauthToken, GitHubRepository gitHubRepository)
void	createSecret(String oauthToken, String owner, String repo, String secretName, GitHubSecret secret)
void	deleteRepository(String oauthToken, String owner, String repo)
GitHubRepository	getRepository(String oauthToken, String owner, String repo)
GitHubSecretsPublicKey	getSecretPublicKey(String oauthToken, String owner, String repo)
GitHubUser	getUser(String oauthToken)
GitHubWorkflowRun	getWorkflowRun(String oauthToken, String owner, String repo, Long runId)
GitHubWorkflowRuns	listWorkflows(String oauthToken, String owner, String repo)

Method Details

createRepository

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

getRepository

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

deleteRepository

@Delete("/repos/{owner}/{repo}")
void deleteRepository(@Header("Authorization")
 String oauthToken,
 @PathVariable
 String owner,
 @PathVariable
 String repo)

getUser

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

createSecret

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

getSecretPublicKey

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

listWorkflows

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

getWorkflowRun

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