Package io.apicurio.registry.rest.v1

Interface RulesResource

@Path("/apis/registry/v1/rules") public interface RulesResource
A JAX-RS interface. An implementation of this interface must be provided.

  • Method Details

    • getGlobalRuleConfig

      @Path("/{rule}") @GET @Produces("application/json") Rule getGlobalRuleConfig(@PathParam("rule") RuleType rule)
      Returns information about the named globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`)

    • updateGlobalRuleConfig

      @Path("/{rule}") @PUT @Produces("application/json") @Consumes("application/json") Rule updateGlobalRuleConfig(@PathParam("rule") RuleType rule, Rule data)
      Updates the configuration for a globally configured rule. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * A server error occurred (HTTP error `500`)

    • deleteGlobalRule

      @Path("/{rule}") @DELETE void deleteGlobalRule(@PathParam("rule") RuleType rule)
      Deletes a single global rule. If this is the only rule configured, this is the same as deleting **all** rules. Default global rules that have been configured via `registry.rules.global` environment variables cannot be deleted. This operation can fail for the following reasons: * Invalid rule name/type (HTTP error `400`) * No rule with name/type `rule` exists (HTTP error `404`) * Default rule with name/type `rule` cannot be deleted (HTTP error `409`) * A server error occurred (HTTP error `500`)

    • listGlobalRules

      @GET @Produces("application/json") List<RuleType> listGlobalRules()
      Gets a list of all the currently configured global rules (if any). This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)

    • createGlobalRule

      @POST @Consumes("application/json") void createGlobalRule(Rule data)
      Adds a rule to the list of globally configured rules. This operation can fail for the following reasons: * The rule type is unknown (HTTP error `400`) * The rule already exists (HTTP error `409`) * A server error occurred (HTTP error `500`)

    • deleteAllGlobalRules

      @DELETE void deleteAllGlobalRules()
      Deletes all globally configured rules. Default global rules that have been configured via `registry.rules.global` environment variables cannot be deleted. This operation can fail for the following reasons: * A server error occurred (HTTP error `500`)