io.apicurio.registry.rest.v3.SystemResource Maven / Gradle / Ivy
The newest version!
package io.apicurio.registry.rest.v3;
import io.apicurio.registry.rest.v3.beans.Limits;
import io.apicurio.registry.rest.v3.beans.SystemInfo;
import io.apicurio.registry.rest.v3.beans.UserInterfaceConfig;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
/**
* A JAX-RS interface. An implementation of this interface must be provided.
*/
@Path("/apis/registry/v3/system")
public interface SystemResource {
/**
*
* This operation retrieves information about the running registry system, such
* as the version of the software and when it was built.
*
*
*/
@Path("/info")
@GET
@Produces("application/json")
SystemInfo getSystemInfo();
/**
*
* This operation retrieves the list of limitations on used resources, that are
* applied on the current instance of Registry.
*
*
*/
@Path("/limits")
@GET
@Produces("application/json")
Limits getResourceLimits();
/**
*
* Returns the UI configuration properties for this server. The registry UI can
* be connected to a backend using just a URL. The rest of the UI configuration
* can then be fetched from the backend using this operation. This allows UI and
* backend to both be configured in the same place.
*
*
* This operation may fail for one of the following reasons:
*
*
* - A server error occurred (HTTP error
500)
*
*
*/
@Path("/uiConfig")
@GET
@Produces("application/json")
UserInterfaceConfig getUIConfig();
}