Package io.apicurio.registry.rest.v1

Interface SearchResource

@Path("/apis/registry/v1/search")
public interface SearchResource

A JAX-RS interface. An implementation of this interface must be provided.

Method Summary

Modifier and Type	Method	Description
ArtifactSearchResults	searchArtifacts(String search, Integer offset, Integer limit, SearchOver over, SortOrder order)	Returns a paginated list of all artifacts that match the provided search criteria.
VersionSearchResults	searchVersions(String artifactId, Integer offset, Integer limit)	Searches for versions of a specific artifact.

Method Details

searchArtifacts

@Path("/artifacts")
@GET
@Produces("application/json")
ArtifactSearchResults searchArtifacts(@QueryParam("search")
 String search,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("over")
 SearchOver over,
 @QueryParam("order")
 SortOrder order)

Returns a paginated list of all artifacts that match the provided search criteria.

searchVersions

@Path("/artifacts/{artifactId}/versions")
@GET
@Produces("application/json")
VersionSearchResults searchVersions(@PathParam("artifactId")
 String artifactId,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit)

Searches for versions of a specific artifact. This is typically used to get a listing of all versions of an Artifact (for example in a user interface).