Interface SearchResource


  • @Path("/apis/registry/v2/search")
    public interface SearchResource
    A JAX-RS interface. An implementation of this interface must be provided.
    • Method Detail

      • searchArtifacts

        @Path("/artifacts")
        @GET
        @Produces("application/json")
        ArtifactSearchResults searchArtifacts​(@QueryParam("name")
                                              String name,
                                              @QueryParam("offset")
                                              Integer offset,
                                              @QueryParam("limit")
                                              Integer 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)
        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")
                                                       ArtifactType artifactType,
                                                       @QueryParam("offset")
                                                       Integer offset,
                                                       @QueryParam("limit")
                                                       Integer limit,
                                                       @QueryParam("order")
                                                       SortOrder order,
                                                       @QueryParam("orderby")
                                                       SortBy orderby,
                                                       InputStream data)
        Returns a paginated list of all artifacts with at least one version that matches the posted content.