io.confluent.kafka.schemaregistry.rest.resources

Class SubjectVersionsResource

java.lang.Object

io.confluent.kafka.schemaregistry.rest.resources.SubjectVersionsResource

@Path(value="/subjects/{subject}/versions")
 @Produces(value={"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json; qs=0.9","application/json; qs=0.5"})
 @Consumes(value={"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json","application/json","application/octet-stream"})
public class SubjectVersionsResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	apiTag

Constructor Summary

Constructors

Constructor and Description
SubjectVersionsResource(KafkaSchemaRegistry registry)

Method Summary

Modifier and Type	Method and Description
void	deleteSchemaVersion(javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.HttpHeaders headers, String subject, String version, boolean permanentDelete)
List<Integer>	getReferencedBy(String subject, String version)
Schema	getSchemaByVersion(String subject, String version, String format, boolean lookupDeletedSchema, List<String> tags)
String	getSchemaOnly(String subject, String version, String format, boolean lookupDeletedSchema)
List<Integer>	listVersions(String subject, boolean lookupDeletedSchema, boolean lookupDeletedOnlySchema)
void	modifyTags(javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.HttpHeaders headers, String subjectName, String version, @NotNull TagSchemaRequest request)
void	register(javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.HttpHeaders headers, String subjectName, boolean normalize, String format, @NotNull RegisterSchemaRequest request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

apiTag

public static final String apiTag

See Also:

Constant Field Values

Constructor Detail

SubjectVersionsResource

public SubjectVersionsResource(KafkaSchemaRegistry registry)

Method Detail

getSchemaByVersion

@GET
 @Path(value="/{version}")
 @DocumentedName(value="getSchemaByVersion")
 @PerformanceMetric(value="subjects.versions.get-schema")
public Schema getSchemaByVersion(@PathParam(value="subject")
                                                                                                                                                                        String subject,
                                                                                                                                                                        @PathParam(value="version")
                                                                                                                                                                        String version,
                                                                                                                                                                        @DefaultValue(value="") @QueryParam(value="format")
                                                                                                                                                                        String format,
                                                                                                                                                                        @QueryParam(value="deleted")
                                                                                                                                                                        boolean lookupDeletedSchema,
                                                                                                                                                                        @QueryParam(value="findTags")
                                                                                                                                                                        List<String> tags)

getSchemaOnly

@GET
 @Path(value="/{version}/schema")
 @DocumentedName(value="getVersionSchemaOnly")
 @PerformanceMetric(value="subjects.versions.get-schema.only")
public String getSchemaOnly(@PathParam(value="subject")
                                                                                                                                                                                 String subject,
                                                                                                                                                                                 @PathParam(value="version")
                                                                                                                                                                                 String version,
                                                                                                                                                                                 @DefaultValue(value="") @QueryParam(value="format")
                                                                                                                                                                                 String format,
                                                                                                                                                                                 @QueryParam(value="deleted")
                                                                                                                                                                                 boolean lookupDeletedSchema)

getReferencedBy

@GET
 @Path(value="/{version}/referencedby")
 @DocumentedName(value="getReferencedBy")
 @PerformanceMetric(value="subjects.versions.list-schema-refs")
public List<Integer> getReferencedBy(@PathParam(value="subject")
                                                                                                                                                                                            String subject,
                                                                                                                                                                                            @PathParam(value="version")
                                                                                                                                                                                            String version)

listVersions

@GET
 @DocumentedName(value="getAllVersions")
 @PerformanceMetric(value="subjects.versions.list")
public List<Integer> listVersions(@PathParam(value="subject")
                                                                                                                                    String subject,
                                                                                                                                    @QueryParam(value="deleted")
                                                                                                                                    boolean lookupDeletedSchema,
                                                                                                                                    @QueryParam(value="deletedOnly")
                                                                                                                                    boolean lookupDeletedOnlySchema)

register

@POST
 @DocumentedName(value="registerSchema")
 @PerformanceMetric(value="subjects.versions.register")
public void register(@Suspended
                                                                                                                            javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                                                            @Context
                                                                                                                            javax.ws.rs.core.HttpHeaders headers,
                                                                                                                            @PathParam(value="subject")
                                                                                                                            String subjectName,
                                                                                                                            @QueryParam(value="normalize")
                                                                                                                            boolean normalize,
                                                                                                                            @DefaultValue(value="") @QueryParam(value="format")
                                                                                                                            String format,
                                                                                                                            @NotNull
                                                                                                                            @NotNull RegisterSchemaRequest request)

deleteSchemaVersion

@DELETE
 @Path(value="/{version}")
 @DocumentedName(value="deleteSchemaVersion")
 @PerformanceMetric(value="subjects.versions.deleteSchemaVersion-schema")
public void deleteSchemaVersion(@Suspended
                                                                                                                                                                                           javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                                                                                                                           @Context
                                                                                                                                                                                           javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                                           @PathParam(value="subject")
                                                                                                                                                                                           String subject,
                                                                                                                                                                                           @PathParam(value="version")
                                                                                                                                                                                           String version,
                                                                                                                                                                                           @QueryParam(value="permanent")
                                                                                                                                                                                           boolean permanentDelete)

modifyTags

@POST
 @Path(value="/{version}/tags")
 @DocumentedName(value="modifySchemaTags")
 @PerformanceMetric(value="subjects.versions.modify.tags")
public void modifyTags(@Suspended
                                                                                                                                                                   javax.ws.rs.container.AsyncResponse asyncResponse,
                                                                                                                                                                   @Context
                                                                                                                                                                   javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                   @PathParam(value="subject")
                                                                                                                                                                   String subjectName,
                                                                                                                                                                   @PathParam(value="version")
                                                                                                                                                                   String version,
                                                                                                                                                                   @NotNull
                                                                                                                                                                   @NotNull TagSchemaRequest request)