Package io.superstudios.plugins.diversion

Class DiversionApiClient

java.lang.Object

io.superstudios.plugins.diversion.DiversionApiClient

public class DiversionApiClient
extends Object

Client for interacting with Diversion API. Based on Diversion API documentation: https://docs.diversion.dev/api-reference/introduction

Constructor Summary

Constructors

Constructor	Description
DiversionApiClient(String credentialsId)	Constructor for use outside of a Run context (e.g., UI dropdowns)
DiversionApiClient(String credentialsId, Run<?,?> run)	Constructor for use during a Run (build execution)

Method Summary

Modifier and Type	Method	Description
DiversionTag	createTag(String repositoryId, String tagName, String commitId, String description)	Create a new tag
void	deleteTag(String repositoryId, String tagId)	Delete a tag
DiversionBranch	getBranchDetails(String repositoryId, String branchIdOrName)	Get branch details by ID or name
DiversionCommit	getCommitDetails(String repositoryId, String commitId)	Get detailed commit information including changed files
String	getFileContent(String repositoryId, String ref, String filePath)	Get file content by path and ref
List<DiversionFile>	getFileTree(String repositoryId, String ref)	Get file tree for a repository Uses the /repos/{repo_id}/trees/{ref_id} endpoint
DiversionCommit	getLatestCommit(String repositoryId, String branchId)	Get the latest commit for a specific branch Uses the branch's current commit ID to get the actual commit details
DiversionRepository	getRepository(String repositoryId)	Get repository details
DiversionTag	getTag(String repositoryId, String tagId)	Get a specific tag by ID
List<DiversionBranch>	listBranches(String repositoryId)	List all branches for a repository
List<DiversionCommit>	listCommits(String repositoryId, int limit)	List commits for a repository
List<DiversionRepository>	listRepositories()	List all repositories accessible to the user Useful for UI dropdown selection
List<DiversionTag>	listTags(String repositoryId)	List all tags for a repository
String	resolveBranchId(String repositoryId, String branchNameOrId)	Resolve branch name to ID Returns branch ID if already an ID, otherwise looks up by name
boolean	testAuthentication()	Test authentication with Diversion API

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DiversionApiClient

public DiversionApiClient(String credentialsId,
 Run<?,?> run)

Constructor for use during a Run (build execution)

Parameters:

credentialsId - The credential ID to use

run - The Run context (used to resolve folder-scoped credentials)

DiversionApiClient

public DiversionApiClient(String credentialsId)

Constructor for use outside of a Run context (e.g., UI dropdowns)

Parameters:

credentialsId - The credential ID to use

Method Details

testAuthentication

public boolean testAuthentication()
                           throws IOException,
InterruptedException

Test authentication with Diversion API

Throws:

IOException

InterruptedException

getRepository

public DiversionRepository getRepository(String repositoryId)
                                  throws IOException,
InterruptedException

Get repository details

Throws:

IOException

InterruptedException

getFileTree

public List<DiversionFile> getFileTree(String repositoryId,
 String ref)
                                throws IOException,
InterruptedException

Get file tree for a repository Uses the /repos/{repo_id}/trees/{ref_id} endpoint

Throws:

IOException

InterruptedException

getFileContent

public String getFileContent(String repositoryId,
 String ref,
 String filePath)
                      throws IOException,
InterruptedException

Get file content by path and ref

Throws:

IOException

InterruptedException

listRepositories

public List<DiversionRepository> listRepositories()
                                           throws IOException,
InterruptedException

List all repositories accessible to the user Useful for UI dropdown selection

Throws:

IOException

InterruptedException

listBranches

public List<DiversionBranch> listBranches(String repositoryId)
                                   throws IOException,
InterruptedException

List all branches for a repository

Throws:

IOException

InterruptedException

getBranchDetails

public DiversionBranch getBranchDetails(String repositoryId,
 String branchIdOrName)
                                 throws IOException,
InterruptedException

Get branch details by ID or name

Throws:

IOException

InterruptedException

resolveBranchId

public String resolveBranchId(String repositoryId,
 String branchNameOrId)
                       throws IOException,
InterruptedException

Resolve branch name to ID Returns branch ID if already an ID, otherwise looks up by name

Throws:

IOException

InterruptedException

listCommits

public List<DiversionCommit> listCommits(String repositoryId,
 int limit)
                                  throws IOException,
InterruptedException

List commits for a repository

Throws:

IOException

InterruptedException

getLatestCommit

public DiversionCommit getLatestCommit(String repositoryId,
 String branchId)
                                throws IOException,
InterruptedException

Get the latest commit for a specific branch Uses the branch's current commit ID to get the actual commit details

Throws:

IOException

InterruptedException

getCommitDetails

public DiversionCommit getCommitDetails(String repositoryId,
 String commitId)
                                 throws IOException,
InterruptedException

Get detailed commit information including changed files

Throws:

IOException

InterruptedException

listTags

public List<DiversionTag> listTags(String repositoryId)
                            throws IOException,
InterruptedException

List all tags for a repository

Throws:

IOException

InterruptedException

getTag

public DiversionTag getTag(String repositoryId,
 String tagId)
                    throws IOException,
InterruptedException

Get a specific tag by ID

Throws:

IOException

InterruptedException

createTag

public DiversionTag createTag(String repositoryId,
 String tagName,
 String commitId,
 String description)
                       throws IOException,
InterruptedException

Create a new tag

Throws:

IOException

InterruptedException

deleteTag

public void deleteTag(String repositoryId,
 String tagId)
               throws IOException,
InterruptedException

Delete a tag

Throws:

IOException

InterruptedException