Package io.confluent.kafka.schemaregistry.rest.resources

Class SubjectVersionsResource

java.lang.Object

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

@Path("/subjects/{subject}/versions")
@Produces({"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json; qs=0.9","application/json; qs=0.5"})
@Consumes({"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	Description
static final String	apiTag

Constructor Summary

Constructors

Constructor	Description
SubjectVersionsResource(SchemaRegistry registry)

Method Summary

Modifier and Type	Method	Description
void	deleteSchemaVersion(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String subject, String version, boolean permanentDelete)
List<Integer>	getReferencedBy(String subject, String version, int offset, int limit)
Schema	getSchemaByVersion(String subject, String version, String format, String referenceFormat, boolean lookupDeletedSchema, List<String> tags)
String	getSchemaOnly(String subject, String version, String format, boolean lookupDeletedSchema)
List<Integer>	listVersions(String subject, boolean lookupDeletedSchema, boolean lookupDeletedOnlySchema, boolean deletedAsNegative, int offset, int limit)
void	modifyTags(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.ws.rs.core.HttpHeaders headers, String subjectName, String version, @NotNull TagSchemaRequest request)
void	register(jakarta.ws.rs.container.AsyncResponse asyncResponse, jakarta.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 Details

apiTag

public static final String apiTag

See Also:

• Constant Field Values

Constructor Details

SubjectVersionsResource

@Inject
public SubjectVersionsResource(SchemaRegistry registry)

Method Details

getSchemaByVersion

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

getSchemaOnly

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

getReferencedBy

@GET
@Path("/{version}/referencedby")
@DocumentedName("getReferencedBy")
@PerformanceMetric("subjects.versions.list-schema-refs")
public List<Integer> getReferencedBy(@PathParam("subject")
 String subject,
 @PathParam("version")
 String version,
 @DefaultValue("0") @QueryParam("offset")
 int offset,
 @DefaultValue("-1") @QueryParam("limit")
 int limit)

listVersions

@GET
@DocumentedName("getAllVersions")
@PerformanceMetric("subjects.versions.list")
public List<Integer> listVersions(@PathParam("subject")
 String subject,
 @QueryParam("deleted")
 boolean lookupDeletedSchema,
 @QueryParam("deletedOnly")
 boolean lookupDeletedOnlySchema,
 @QueryParam("deletedAsNegative")
 boolean deletedAsNegative,
 @DefaultValue("0") @QueryParam("offset")
 int offset,
 @DefaultValue("-1") @QueryParam("limit")
 int limit)

register

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

deleteSchemaVersion

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

modifyTags

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