com.hubspot.singularity.resources.RequestGroupResource Maven / Gradle / Ivy

Go to download
package com.hubspot.singularity.resources;

import java.util.List;

import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;

import com.google.common.base.Optional;
import com.google.inject.Inject;
import com.hubspot.singularity.SingularityRequestGroup;
import com.hubspot.singularity.config.ApiPaths;
import com.hubspot.singularity.data.RequestGroupManager;
import com.hubspot.singularity.data.SingularityValidator;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.parameters.RequestBody;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.tags.Tags;

@Path(ApiPaths.REQUEST_GROUP_RESOURCE_PATH)
@Produces({MediaType.APPLICATION_JSON})
@Schema(title = "Manages Singularity Request Groups, which are collections of one or more Singularity Requests")
@Tags({@Tag(name = "Request Groups")})
public class RequestGroupResource {
  private final RequestGroupManager requestGroupManager;
  private final SingularityValidator validator;

  @Inject
  public RequestGroupResource(RequestGroupManager requestGroupManager, SingularityValidator validator) {
    this.requestGroupManager = requestGroupManager;
    this.validator = validator;
  }

  @GET
  @Operation(summary = "Get a list of Singularity request groups")
  public List getRequestGroupIds(
      @Parameter(description = "Use a cached version of this data to limit expensive api calls") @QueryParam("useWebCache") Boolean useWebCache) {
    return requestGroupManager.getRequestGroups(useWebCache != null && useWebCache);
  }

  @GET
  @Path("/group/{requestGroupId}")
  @Operation(
      summary = "Get a specific Singularity request group by ID",
      responses = {
          @ApiResponse(responseCode = "404", description = "The specified request group was not found")
      }
  )
  public Optional getRequestGroup(
      @Parameter(required = true, description = "The id of the request group") @PathParam("requestGroupId") String requestGroupId) {
    return requestGroupManager.getRequestGroup(requestGroupId);
  }

  @DELETE
  @Path("/group/{requestGroupId}")
  @Operation(summary = "Delete a specific Singularity request group by ID")
  public void deleteRequestGroup(
      @Parameter(required = true, description = "The id of the request group") @PathParam("requestGroupId") String requestGroupId) {
    requestGroupManager.deleteRequestGroup(requestGroupId);
  }

  @POST
  @Operation(summary = "Create a Singularity request group")
  public SingularityRequestGroup saveRequestGroup(
      @RequestBody(required = true, description = "The new request group to create") SingularityRequestGroup requestGroup) {
    validator.checkRequestGroup(requestGroup);

    requestGroupManager.saveRequestGroup(requestGroup);

    return requestGroup;
  }
}