Package io.apicurio.multitenant.api
Interface TenantsResource
-
@Path("/api/v1/tenants") public interface TenantsResource
A JAX-RS interface. An implementation of this interface must be provided.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description javax.ws.rs.core.Response
createTenant(NewRegistryTenantRequest data)
Creates a new instance of a `Tenant`.void
deleteTenant(String tenantId)
Marks an existing `Tenant` to be deleted.RegistryTenant
getTenant(String tenantId)
Gets the details of a single instance of a `Tenant`.RegistryTenantList
getTenants(String status, @Min(0L) Integer offset, @Min(1L) @Max(500L) Integer limit, SortOrder order, SortBy orderby)
Gets a list of `RegistryTenant` entities according to the query parameters set.void
updateTenant(String tenantId, UpdateRegistryTenantRequest data)
Updates the name, description, and resources for a tenant.
-
-
-
Method Detail
-
getTenant
@Path("/{tenantId}") @GET @Produces("application/json") RegistryTenant getTenant(@PathParam("tenantId") String tenantId)
Gets the details of a single instance of a `Tenant`.
-
updateTenant
@Path("/{tenantId}") @PUT @Consumes("application/json") void updateTenant(@PathParam("tenantId") String tenantId, UpdateRegistryTenantRequest data)
Updates the name, description, and resources for a tenant.
-
deleteTenant
@Path("/{tenantId}") @DELETE void deleteTenant(@PathParam("tenantId") String tenantId)
Marks an existing `Tenant` to be deleted.
-
getTenants
@GET @Produces("application/json") RegistryTenantList getTenants(@QueryParam("status") String status, @QueryParam("offset") @Min(0L) @Min(0L) Integer offset, @QueryParam("limit") @Min(1L) @Max(500L) @Min(1L) @Max(500L) Integer limit, @QueryParam("order") SortOrder order, @QueryParam("orderby") SortBy orderby)
Gets a list of `RegistryTenant` entities according to the query parameters set.
-
createTenant
@POST @Produces("application/json") @Consumes("application/json") javax.ws.rs.core.Response createTenant(NewRegistryTenantRequest data)
Creates a new instance of a `Tenant`.
-
-