Interface SubjectsResource

  • All Known Implementing Classes:
    SubjectsResourceImpl

    @Path("/apis/ccompat/v6/subjects")
    @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 SubjectsResource
    Note:

    This API specification is owned by Confluent.

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

      • listSubjects

        @GET
        List<String> listSubjects()
        Get a list of registered subjects. Response JSON Array of Objects: name (string) – Subject Status Codes: 500 Internal Server Error – Error code 50001 – Error in the backend datastore
      • findSchemaByContent

        @POST
        @Path("/{subject}")
        Schema findSchemaByContent​(@PathParam("subject")
                                   String subject,
                                   @NotNull
                                   @NotNull SchemaContent request)
                            throws Exception
        Check if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name. Parameters: subject (string) – Subject under which the schema will be registered Response JSON Object: subject (string) – Name of the subject that this schema is registered under globalId (int) – Globally unique identifier of the schema version (int) – Version of the returned schema schema (string) – The schema string Status Codes: 404 Not Found – Error code 40401 – Subject not found Error code 40403 – Schema not found 500 Internal Server Error – Internal server error
        Throws:
        Exception
      • deleteSubject

        @DELETE
        @Path("/{subject}")
        List<Integer> deleteSubject​(@PathParam("subject")
                                    String subject)
                             throws Exception
        Deletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only when a topic needs to be recycled or in development environment. Parameters: subject (string) – the name of the subject Response JSON Array of Objects: version (int) – version of the schema deleted under this subject Status Codes: 404 Not Found – Error code 40401 – Subject not found 500 Internal Server Error – Error code 50001 – Error in the backend datastore
        Throws:
        Exception