Package io.apicurio.registry.rest.v3

Interface SearchResource

@Path("/apis/registry/v3/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, ArtifactSortBy orderby, List<String> labels, String description, String groupId, Long globalId, Long contentId, String artifactId)	Returns a paginated list of all artifacts that match the provided filter criteria.
ArtifactSearchResults	searchArtifactsByContent(Boolean canonical, String artifactType, String groupId, BigInteger offset, BigInteger limit, SortOrder order, ArtifactSortBy orderby, @NotNull InputStream data)	Returns a paginated list of all artifacts with at least one version that matches the posted content.
GroupSearchResults	searchGroups(BigInteger offset, BigInteger limit, SortOrder order, GroupSortBy orderby, List<String> labels, String description, String groupId)	Returns a paginated list of all groups that match the provided filter criteria.
VersionSearchResults	searchVersions(@Pattern(regexp="^[a-zA-Z0-9._\\-+]{1,256}$") String version, BigInteger offset, BigInteger limit, SortOrder order, VersionSortBy orderby, List<String> labels, String description, @Pattern(regexp="^.{1,512}$") String groupId, Long globalId, Long contentId, @Pattern(regexp="^.{1,512}$") String artifactId, String name, VersionState state)	Returns a paginated list of all versions that match the provided filter criteria.
VersionSearchResults	searchVersionsByContent(Boolean canonical, String artifactType, BigInteger offset, BigInteger limit, SortOrder order, VersionSortBy orderby, @Pattern(regexp="^.{1,512}$") String groupId, @Pattern(regexp="^.{1,512}$") String artifactId, @NotNull InputStream data)	Returns a paginated list of all versions that match 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")
 ArtifactSortBy orderby,
 @QueryParam("labels")
 List<String> labels,
 @QueryParam("description")
 String description,
 @QueryParam("groupId")
 String groupId,
 @QueryParam("globalId")
 Long globalId,
 @QueryParam("contentId")
 Long contentId,
 @QueryParam("artifactId")
 String artifactId)

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

This operation can fail for the following reasons:

• A server error occurred (HTTP error 500)

searchArtifactsByContent

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

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

This operation can fail for the following reasons:

• Provided content (request body) was empty (HTTP error 400)
• A server error occurred (HTTP error 500)

searchGroups

@Path("/groups")
@GET
@Produces("application/json")
GroupSearchResults searchGroups(@QueryParam("offset") @DefaultValue("0")
 BigInteger offset,
 @QueryParam("limit") @DefaultValue("20")
 BigInteger limit,
 @QueryParam("order")
 SortOrder order,
 @QueryParam("orderby")
 GroupSortBy orderby,
 @QueryParam("labels")
 List<String> labels,
 @QueryParam("description")
 String description,
 @QueryParam("groupId")
 String groupId)

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

This operation can fail for the following reasons:

• A server error occurred (HTTP error 500)

searchVersions

@Path("/versions")
@GET
@Produces("application/json")
VersionSearchResults searchVersions(@QueryParam("version") @Pattern(regexp="^[a-zA-Z0-9._\\-+]{1,256}$")
 @Pattern(regexp="^[a-zA-Z0-9._\\-+]{1,256}$") String version,
 @QueryParam("offset") @DefaultValue("0")
 BigInteger offset,
 @QueryParam("limit") @DefaultValue("20")
 BigInteger limit,
 @QueryParam("order")
 SortOrder order,
 @QueryParam("orderby")
 VersionSortBy orderby,
 @QueryParam("labels")
 List<String> labels,
 @QueryParam("description")
 String description,
 @QueryParam("groupId") @Pattern(regexp="^.{1,512}$")
 @Pattern(regexp="^.{1,512}$") String groupId,
 @QueryParam("globalId")
 Long globalId,
 @QueryParam("contentId")
 Long contentId,
 @QueryParam("artifactId") @Pattern(regexp="^.{1,512}$")
 @Pattern(regexp="^.{1,512}$") String artifactId,
 @QueryParam("name")
 String name,
 @QueryParam("state")
 VersionState state)

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

This operation can fail for the following reasons:

• A server error occurred (HTTP error 500)

searchVersionsByContent

@Path("/versions")
@POST
@Produces("application/json")
@Consumes("*/*")
VersionSearchResults searchVersionsByContent(@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")
 VersionSortBy orderby,
 @QueryParam("groupId") @Pattern(regexp="^.{1,512}$")
 @Pattern(regexp="^.{1,512}$") String groupId,
 @QueryParam("artifactId") @Pattern(regexp="^.{1,512}$")
 @Pattern(regexp="^.{1,512}$") String artifactId,
 @NotNull
 @NotNull InputStream data)

Returns a paginated list of all versions that match the posted content.

This operation can fail for the following reasons:

• Provided content (request body) was empty (HTTP error 400)
• A server error occurred (HTTP error 500)