org.finos.legend.sdlc.server.resources.VersionBuildsResource Maven / Gradle / Ivy
// Copyright 2020 Goldman Sachs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package org.finos.legend.sdlc.server.resources;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.finos.legend.sdlc.domain.model.build.Build;
import org.finos.legend.sdlc.domain.model.build.BuildStatus;
import org.finos.legend.sdlc.server.domain.api.build.BuildApi;
import javax.inject.Inject;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
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 java.util.List;
import java.util.Set;
@Path("/projects/{projectId}/versions/{versionId}/builds")
@Api("Builds")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public class VersionBuildsResource extends BaseResource
{
private final BuildApi buildApi;
@Inject
public VersionBuildsResource(BuildApi buildApi)
{
this.buildApi = buildApi;
}
@GET
@ApiOperation(value = "Get builds for a version", notes = "Get builds for a version. If status is provided, then only builds with the given status are returned. Otherwise, all builds are returned. If status is UNKNOWN, results are undefined.")
public List getBuilds(@PathParam("projectId") String projectId,
@PathParam("versionId") String versionId,
@QueryParam("revisionId")
@ApiParam("Only include builds for one of the given revisions") Set revisionIds,
@QueryParam("status")
@ApiParam("Only include builds with one of the given statuses") Set statuses,
@QueryParam("limit")
@ApiParam("Limit the number of builds returned (if not provided or the provided value is non-positive, no filtering will be applied)") Integer limit)
{
return executeWithLogging(
"getting builds for version " + versionId + " in project " + projectId,
() -> this.buildApi.getVersionBuildAccessContext(projectId, versionId).getBuilds(revisionIds, statuses, limit)
);
}
@GET
@Path("{buildId}")
@ApiOperation("Get a build for a version")
public Build getBuild(@PathParam("projectId") String projectId, @PathParam("versionId") String versionId, @PathParam("buildId") String buildId)
{
return executeWithLogging(
"getting build " + buildId + " for version " + versionId + " in project " + projectId,
() -> this.buildApi.getVersionBuildAccessContext(projectId, versionId).getBuild(buildId)
);
}
}