Package io.toolforge.spi.service

Interface AccountsApi

@Path("/accounts")
@Generated(value="org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen",
           date="2023-03-23T19:13:01.140351-05:00[America/Chicago]")
public interface AccountsApi

Method Summary

Modifier and Type	Method	Description
NewApiKey	createAccountApiKey(AccountReference accountReference, @Valid ApiKeyDefinition apiKeyDefinition)
void	deleteAccountApiKey(AccountReference accountReference, ApiKeyId apiKeyId)
Account	getAccount(AccountReference accountReference)
ApiKey	getAccountApiKey(AccountReference accountReference, ApiKeyId apiKeyId)
Account	getAccountById(AccountId accountId)
Account	getAccountByUsername(Username username)
InputStream	getAccountPicture(AccountReference accountReference)
ApiKeyPage	listAccountApiKeys(AccountReference accountReference, @Min(0L) @Max(10L) Integer limit, ApiKeyCursor cursor)
AccountPage	listAccounts(PrefixQuery q, @Min(0L) @Max(100L) Integer limit, AccountCursor cursor, AccountListOrdering order)

Method Details

createAccountApiKey

@POST
@Path("/{accountReference}/apiKeys")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
NewApiKey createAccountApiKey(@PathParam("accountReference")
 AccountReference accountReference,
 @Valid
 @Valid ApiKeyDefinition apiKeyDefinition)

deleteAccountApiKey

@DELETE
@Path("/{accountReference}/apiKeys/{apiKeyId}")
@Produces("application/problem+json")
void deleteAccountApiKey(@PathParam("accountReference")
 AccountReference accountReference,
 @PathParam("apiKeyId")
 ApiKeyId apiKeyId)

getAccount

@GET
@Path("/{accountReference}")
@Produces({"application/json","application/problem+json"})
Account getAccount(@PathParam("accountReference")
 AccountReference accountReference)

getAccountApiKey

@GET
@Path("/{accountReference}/apiKeys/{apiKeyId}")
@Produces({"application/json","application/problem+json"})
ApiKey getAccountApiKey(@PathParam("accountReference")
 AccountReference accountReference,
 @PathParam("apiKeyId")
 ApiKeyId apiKeyId)

getAccountById

@GET
@Path("/by/id/{accountId}")
@Produces({"application/json","application/problem+json"})
Account getAccountById(@PathParam("accountId")
 AccountId accountId)

getAccountByUsername

@GET
@Path("/by/username/{username}")
@Produces({"application/json","application/problem+json"})
Account getAccountByUsername(@PathParam("username")
 Username username)

getAccountPicture

@GET
@Path("/{accountReference}/picture")
@Produces({"image/jpeg","application/problem+json"})
InputStream getAccountPicture(@PathParam("accountReference")
 AccountReference accountReference)

listAccountApiKeys

@GET
@Path("/{accountReference}/apiKeys")
@Produces({"application/json","application/problem+json"})
ApiKeyPage listAccountApiKeys(@PathParam("accountReference")
 AccountReference accountReference,
 @QueryParam("limit") @Min(0L) @Max(10L) @DefaultValue("10")
 @Min(0L) @Max(10L) Integer limit,
 @QueryParam("cursor")
 ApiKeyCursor cursor)

listAccounts

@GET
@Produces("application/json")
AccountPage listAccounts(@QueryParam("q")
 PrefixQuery q,
 @QueryParam("limit") @Min(0L) @Max(100L) @DefaultValue("10")
 @Min(0L) @Max(100L) Integer limit,
 @QueryParam("cursor")
 AccountCursor cursor,
 @QueryParam("order")
 AccountListOrdering order)