Package io.toolforge.spi.service

Interface ContainersApi

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

Method Summary

Modifier and Type	Method	Description
Container	createContainer(@Valid ContainerDefinition containerDefinition)
ContainerVersion	deprecateContainerVersion(ContainerId containerId, ContainerVersionId containerVersion)
Container	findContainerByOwnerSlug(AccountReference owner, String slug)
Container	getContainer(ContainerId containerId)
ContainerVersionPushLogEntries	getContainerPushLogs(ContainerId containerId)
ContainerVersion	getContainerVersion(ContainerId containerId, ContainerVersionId containerVersion)
InstalledContainer	installContainer(ContainerId containerId, @Valid ContainerInstallation containerInstallation)
ContainerPage	listContainers(KeywordQuery q, AccountReference owner, @Min(0L) @Max(100L) Integer limit, ContainerCursor cursor)
ContainerVersionPage	listContainerVersions(ContainerId containerId, Integer limit, ContainerVersionCursor cursor)
ContainerVersion	releaseContainerVersion(ContainerId containerId, ContainerVersionId containerVersion)
Container	transferContainer(ContainerId containerId, @Valid ContainerTransfer containerTransfer)
Container	updateContainer(ContainerId containerId, @Valid ContainerUpdate containerUpdate)
void	validateContainerManifest(ContainerId containerId, @Valid Manifest manifest)

Method Details

createContainer

@POST
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Container createContainer(@Valid
 @Valid ContainerDefinition containerDefinition)

deprecateContainerVersion

@POST
@Path("/{containerId}/versions/{containerVersion}/deprecate")
@Produces({"application/json","application/problem+json"})
ContainerVersion deprecateContainerVersion(@PathParam("containerId")
 ContainerId containerId,
 @PathParam("containerVersion")
 ContainerVersionId containerVersion)

findContainerByOwnerSlug

@GET
@Path("/by/owner/{owner}/slug/{slug}")
@Produces({"application/json","application/problem+json"})
Container findContainerByOwnerSlug(@PathParam("owner")
 AccountReference owner,
 @PathParam("slug")
 String slug)

getContainer

@GET
@Path("/{containerId}")
@Produces({"application/json","application/problem+json"})
Container getContainer(@PathParam("containerId")
 ContainerId containerId)

getContainerPushLogs

@GET
@Path("/{containerId}/logs/push")
@Produces({"application/json","application/problem+json"})
ContainerVersionPushLogEntries getContainerPushLogs(@PathParam("containerId")
 ContainerId containerId)

getContainerVersion

@GET
@Path("/{containerId}/versions/{containerVersion}")
@Produces({"application/json","application/problem+json"})
ContainerVersion getContainerVersion(@PathParam("containerId")
 ContainerId containerId,
 @PathParam("containerVersion")
 ContainerVersionId containerVersion)

installContainer

@POST
@Path("/{containerId}/install")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
InstalledContainer installContainer(@PathParam("containerId")
 ContainerId containerId,
 @Valid
 @Valid ContainerInstallation containerInstallation)

listContainerVersions

@GET
@Path("/{containerId}/versions")
@Produces({"application/json","application/problem+json"})
ContainerVersionPage listContainerVersions(@PathParam("containerId")
 ContainerId containerId,
 @QueryParam("limit") @DefaultValue("10")
 Integer limit,
 @QueryParam("cursor")
 ContainerVersionCursor cursor)

listContainers

@GET
@Produces("application/json")
ContainerPage listContainers(@QueryParam("q")
 KeywordQuery q,
 @QueryParam("owner")
 AccountReference owner,
 @QueryParam("limit") @Min(0L) @Max(100L) @DefaultValue("10")
 @Min(0L) @Max(100L) Integer limit,
 @QueryParam("cursor")
 ContainerCursor cursor)

releaseContainerVersion

@POST
@Path("/{containerId}/versions/{containerVersion}/release")
@Produces({"application/json","application/problem+json"})
ContainerVersion releaseContainerVersion(@PathParam("containerId")
 ContainerId containerId,
 @PathParam("containerVersion")
 ContainerVersionId containerVersion)

transferContainer

@POST
@Path("/{containerId}/transfer")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Container transferContainer(@PathParam("containerId")
 ContainerId containerId,
 @Valid
 @Valid ContainerTransfer containerTransfer)

updateContainer

@PATCH
@Path("/{containerId}")
@Consumes("application/json")
@Produces({"application/json","application/problem+json"})
Container updateContainer(@PathParam("containerId")
 ContainerId containerId,
 @Valid
 @Valid ContainerUpdate containerUpdate)

validateContainerManifest

@POST
@Path("/{containerId}/validate/manifest")
@Consumes("application/yaml")
@Produces("application/problem+json")
void validateContainerManifest(@PathParam("containerId")
 ContainerId containerId,
 @Valid
 @Valid Manifest manifest)