io.apicurio.registry.rest.v3.IdsResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apicurio-registry-common Show documentation
The newest version!
package io.apicurio.registry.rest.v3;

import io.apicurio.registry.rest.v3.beans.ArtifactReference;
import io.apicurio.registry.rest.v3.beans.HandleReferencesType;
import io.apicurio.registry.types.ReferenceType;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.QueryParam;
import jakarta.ws.rs.core.Response;
import java.util.List;

/**
 * A JAX-RS interface. An implementation of this interface must be provided.
 */
@Path("/apis/registry/v3/ids")
public interface IdsResource {
  /**
   * 
   * Gets the content for an artifact version in the registry using its globally
   * unique identifier.
   * 
   * 
   * This operation may fail for one of the following reasons:
   * 
   * 
   * No artifact version with this globalId exists (HTTP error
   * 404)
   * A server error occurred (HTTP error 500)
   * 
   * 
   */
  @Path("/globalIds/{globalId}")
  @GET
  @Produces("*/*")
  Response getContentByGlobalId(@PathParam("globalId") long globalId,
      @QueryParam("references") HandleReferencesType references,
      @QueryParam("returnArtifactType") Boolean returnArtifactType);

  /**
   * 
   * Returns a list containing all the artifact references using the artifact
   * content ID.
   * 
   * 
   * This operation may fail for one of the following reasons:
   * 
   * 
   * A server error occurred (HTTP error 500)
   * 
   * 
   */
  @Path("/contentIds/{contentId}/references")
  @GET
  @Produces("application/json")
  List referencesByContentId(@PathParam("contentId") long contentId);

  /**
   * 
   * Returns a list containing all the artifact references using the artifact
   * global ID.
   * 
   * 
   * This operation may fail for one of the following reasons:
   * 
   * 
   * A server error occurred (HTTP error 500)
   * 
   * 
   */
  @Path("/globalIds/{globalId}/references")
  @GET
  @Produces("application/json")
  List referencesByGlobalId(@PathParam("globalId") long globalId,
      @QueryParam("refType") ReferenceType refType);

  /**
   * 
   * Returns a list containing all the artifact references using the artifact
   * content hash.
   * 
   * 
   * This operation may fail for one of the following reasons:
   * 
   * 
   * A server error occurred (HTTP error 500)
   * 
   * 
   */
  @Path("/contentHashes/{contentHash}/references")
  @GET
  @Produces("application/json")
  List referencesByContentHash(@PathParam("contentHash") String contentHash);

  /**
   * 
   * Gets the content for an artifact version in the registry using the SHA-256
   * hash of the content. This content hash may be shared by multiple artifact
   * versions in the case where the artifact versions have identical content.
   * 
   * 
   * This operation may fail for one of the following reasons:
   * 
   * 
   * No content with this contentHash exists (HTTP error
   * 404)
   * A server error occurred (HTTP error 500)
   * 
   * 
   */
  @Path("/contentHashes/{contentHash}")
  @GET
  @Produces("*/*")
  Response getContentByHash(@PathParam("contentHash") String contentHash);

  /**
   * 
   * Gets the content for an artifact version in the registry using the unique
   * content identifier for that content. This content ID may be shared by
   * multiple artifact versions in the case where the artifact versions are
   * identical.
   * 
   * 
   * This operation may fail for one of the following reasons:
   * 
   * 
   * No content with this contentId exists (HTTP error
   * 404)
   * A server error occurred (HTTP error 500)
   * 
   * 
   */
  @Path("/contentIds/{contentId}")
  @GET
  @Produces("*/*")
  Response getContentById(@PathParam("contentId") long contentId);
}