brooklyn.rest.api.ActivityApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of brooklyn-rest-api Show documentation

Brooklyn REST API Classes

The newest version!

package brooklyn.rest.api;

import brooklyn.rest.apidoc.Apidoc;
import brooklyn.rest.domain.TaskSummary;
import com.wordnik.swagger.core.ApiError;
import com.wordnik.swagger.core.ApiErrors;
import com.wordnik.swagger.core.ApiOperation;
import com.wordnik.swagger.core.ApiParam;

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

@Path("/v1/activities")
@Apidoc("Activities")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public interface ActivityApi {

  @GET
  @Path("/{task}")
  @ApiOperation(value = "Fetch task details", responseClass = "brooklyn.rest.domain.TaskSummary")
  @ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find task")
  })
//  @Produces("text/json")
  public TaskSummary get(
          @ApiParam(value = "Task ID", required = true) @PathParam("task") String taskId
  );

  @GET
  @Path("/{task}/children")
  @ApiOperation(value = "Fetch list of children tasks of this task")
  @ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find task")
  })
  public Iterable children(
          @ApiParam(value = "Task ID", required = true) @PathParam("task") String taskId);

  @GET
  @Path("/{task}/stream/{streamId}")
  @ApiOperation(value = "Return the contents of the given stream")
  @ApiErrors(value = {
      @ApiError(code = 404, reason = "Could not find task or stream")
  })
  public String stream(
          @ApiParam(value = "Task ID", required = true) @PathParam("task") String taskId,
          @ApiParam(value = "Stream ID", required = true) @PathParam("streamId") String streamId);


}