Package io.apicurio.registry.rest.v2

Interface SearchResource

@Path("/apis/registry/v2/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 name, BigInteger offset, BigInteger limit, SortOrder order, SortBy orderby, List<String> labels, List<String> properties, String description, String group, Long globalId, Long contentId)	Returns a paginated list of all artifacts that match the provided filter criteria.
ArtifactSearchResults	searchArtifactsByContent(Boolean canonical, String artifactType, BigInteger offset, BigInteger limit, SortOrder order, SortBy orderby, @NotNull InputStream data)	Returns a paginated list of all artifacts with at least one version that matches the posted content.

Method Details

searchArtifacts

@Path("/artifacts")
@GET
@Produces("application/json")
ArtifactSearchResults searchArtifacts(@QueryParam("name")
 String name,
 @QueryParam("offset") @DefaultValue("0")
 BigInteger offset,
 @QueryParam("limit") @DefaultValue("20")
 BigInteger limit,
 @QueryParam("order")
 SortOrder order,
 @QueryParam("orderby")
 SortBy orderby,
 @QueryParam("labels")
 List<String> labels,
 @QueryParam("properties")
 List<String> properties,
 @QueryParam("description")
 String description,
 @QueryParam("group")
 String group,
 @QueryParam("globalId")
 Long globalId,
 @QueryParam("contentId")
 Long contentId)

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

searchArtifactsByContent

@Path("/artifacts")
@POST
@Produces("application/json")
@Consumes("*/*")
ArtifactSearchResults searchArtifactsByContent(@QueryParam("canonical")
 Boolean canonical,
 @QueryParam("artifactType")
 String artifactType,
 @QueryParam("offset") @DefaultValue("0")
 BigInteger offset,
 @QueryParam("limit") @DefaultValue("20")
 BigInteger limit,
 @QueryParam("order")
 SortOrder order,
 @QueryParam("orderby")
 SortBy orderby,
 @NotNull
 @NotNull InputStream data)

Returns a paginated list of all artifacts with at least one version that matches the posted content.