Interface CompatibilityResource

  • All Known Implementing Classes:
    CompatibilityResourceImpl

    @Path("/apis/ccompat/v6/compatibility")
    @Consumes({"application/json","application/octet-stream","application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json"})
    @Produces({"application/json","application/octet-stream","application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json"})
    public interface CompatibilityResource
    Note:

    This API specification is owned by Confluent. The compatibility resource allows the user to test schemas for compatibility against specific versions of a subject’s schema.

    Author:
    Ales Justin, Jakub Senko 'jsenko@redhat.com'
    • Method Detail

      • testCompatibilityBySubjectName

        @POST
        @Path("/subjects/{subject}/versions/{version}")
        CompatibilityCheckResponse testCompatibilityBySubjectName​(@PathParam("subject")
                                                                  String subject,
                                                                  @PathParam("version")
                                                                  String version,
                                                                  @NotNull
                                                                  @NotNull SchemaContent request)
                                                           throws Exception
        Test input schema against a particular version of a subject’s schema for compatibility. Note that the compatibility level applied for the check is the configured compatibility level for the subject (GET /config/(string: subject)). If this subject’s compatibility level was never changed, then the global compatibility level applies (GET /config).
        Parameters:
        subject - Subject of the schema version against which compatibility is to be tested
        version - Version of the subject’s schema against which compatibility is to be tested. Valid values for versionId are between [1,2^31-1] or the string "latest". "latest" checks compatibility of the input schema with the last registered schema under the specified subject Status Codes: 404 Not Found Error code 40401 – Subject not found Error code 40402 – Version not found 422 Unprocessable Entity Error code 42201 – Invalid schema Error code 42202 – Invalid version 500 Internal Server Error Error code 50001 – Error in the backend data store
        Throws:
        Exception