Package io.apicurio.registry.rest.v3

Interface SystemResource

@Path("/apis/registry/v3/system") public interface SystemResource
A JAX-RS interface. An implementation of this interface must be provided.

  • Method Summary

    Modifier and Type
    Method
    Description
    Limits
    getResourceLimits()
    This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry.
    SystemInfo
    getSystemInfo()
    This operation retrieves information about the running registry system, such as the version of the software and when it was built.
    UserInterfaceConfig
    getUIConfig()
    Returns the UI configuration properties for this server.

  • Method Details

    • getSystemInfo

      @Path("/info") @GET @Produces("application/json") SystemInfo getSystemInfo()

      This operation retrieves information about the running registry system, such as the version of the software and when it was built.

    • getResourceLimits

      @Path("/limits") @GET @Produces("application/json") Limits getResourceLimits()

      This operation retrieves the list of limitations on used resources, that are applied on the current instance of Registry.

    • getUIConfig

      @Path("/uiConfig") @GET @Produces("application/json") UserInterfaceConfig getUIConfig()

      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)