openecomp-be/api/openecomp-sdc-rest-webapp/activity-log-rest/activity-log-rest-services/src/main/java/org/openecomp/sdcrests/activitylog/rest/ActivityLog.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdcrests.activitylog.rest;
  22
  23 import io.swagger.annotations.Api;
  24 import io.swagger.annotations.ApiOperation;
  25 import io.swagger.annotations.ApiParam;
  26 import org.openecomp.sdcrests.activitylog.types.ActivityLogDto;
  27 import org.springframework.validation.annotation.Validated;
  28
  29 import javax.validation.constraints.NotNull;
  30 import javax.ws.rs.*;
  31 import javax.ws.rs.core.MediaType;
  32 import javax.ws.rs.core.Response;
  33
  34 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  35 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  36
  37
  38 @Path("/v1.0/activity-logs")
  39 @Produces(MediaType.APPLICATION_JSON)
  40 @Consumes(MediaType.APPLICATION_JSON)
  41 @Api(value = "Item Activity Log")
  42 @Validated
  43 public interface ActivityLog {
  44
  45     @GET
  46     @Path("/{itemId}/versions/{versionId}")
  47     @ApiOperation(value = "List actions log of item",
  48             response = ActivityLogDto.class,
  49             responseContainer = "List")
  50     Response getActivityLog(@ApiParam("Item Id") @PathParam("itemId") String itemId,
  51                             @ApiParam("Version Id") @PathParam("versionId") String versionId,
  52                             @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  53                             String user);
  54
  55 }